Add deprecation warning

danijar · Sep 4, 2024 · 293fb9a · 293fb9a
1 parent 00acbcc
commit 293fb9a
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,6 +4,13 @@
 
 Remote function calls for array data using [ZMQ](https://zeromq.org/).
 
+**NOTE: Zerofun has been rewritten without ZMQ using raw Python sockets and is
+now called Portal. You can keep using Zerofun but it will receive no further
+updates. To suppress the message, install `zerofun==2.3.1`. To upgrade, run
+`pip install portal` and visit github.com/danijar/portal. The API is nearly the
+same but allows for more flexible function arguments and offers higher
+performance and reliability.**
+
 ## Overview
 
 Zerofun provides a `Server` that you can bind functions to and a `Client` that

diff --git a/zerofun/__init__.py b/zerofun/__init__.py
@@ -1,4 +1,11 @@
-__version__ = '2.3.1'
+__version__ = '2.4.0'
+
+print("""NOTE: Zerofun has been rewritten without ZMQ using raw Python sockets
+and is now called Portal. You can keep using Zerofun but it will receive no
+further updates. To suppress the message, pin the version to `zerofun==2.3.1`.
+To upgrade, run `pip install portal` and visit github.com/danijar/portal. The
+API is nearly the same but allows for more flexible function arguments and
+offers higher performance and reliability.""")
 
 import multiprocessing as mp
 try: