← back to Exo

add entry_point exo to run main.py

fa67ee9bba5620d513d2f56b7c516f2fb94b3804 · 2024-09-08 18:18:29 +0200 · Gaetan Lepage

Files touched

• M README.md
• M exo/main.py
• M setup.py

Diff

commit fa67ee9bba5620d513d2f56b7c516f2fb94b3804
Author: Gaetan Lepage <gaetan@glepage.com>
Date:   Sun Sep 8 18:18:29 2024 +0200

    add entry_point exo to run main.py
---
 README.md   | 14 +++++++-------
 exo/main.py |  5 ++++-
 setup.py    |  1 +
 3 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 27850679..02954b41 100644
--- a/README.md
+++ b/README.md
@@ -108,12 +108,12 @@ source install.sh
 #### Device 1:
 
 ```sh
-python3 main.py
+exo
 ```
 
 #### Device 2:
 ```sh
-python3 main.py
+exo
 ```
 
 That's it! No configuration required - exo will automatically discover the other device(s).
@@ -179,14 +179,14 @@ curl http://localhost:8000/v1/chat/completions \
 #### Device 1 (MacOS):
 
 ```sh
-python3 main.py --inference-engine tinygrad
+exo --inference-engine tinygrad
 ```
 
 Here we explicitly tell exo to use the **tinygrad** inference engine.
 
 #### Device 2 (Linux):
 ```sh
-python3 main.py
+exo
 ```
 
 Linux devices will automatically default to using the **tinygrad** inference engine.
@@ -199,18 +199,18 @@ You can read about tinygrad-specific env vars [here](https://docs.tinygrad.org/e
 Enable debug logs with the DEBUG environment variable (0-9).
 
 ```sh
-DEBUG=9 python3 main.py
+DEBUG=9 exo
 ```
 
 For the **tinygrad** inference engine specifically, there is a separate DEBUG flag `TINYGRAD_DEBUG` that can be used to enable debug logs (1-6).
 
 ```sh
-TINYGRAD_DEBUG=2 python3 main.py
+TINYGRAD_DEBUG=2 exo
 ```
 
 ## Known Issues
 
-- On some versions of MacOS/Python, certificates are not installed properly which can lead to SSL errors (e.g. SSL error with huggingface.co). To fix this, run the Install Certificates command, usually: 
+- On some versions of MacOS/Python, certificates are not installed properly which can lead to SSL errors (e.g. SSL error with huggingface.co). To fix this, run the Install Certificates command, usually:
 
 ```sh
 /Applications/Python 3.x/Install Certificates.command
diff --git a/exo/main.py b/exo/main.py
index 6132bc67..6b86e478 100644
--- a/exo/main.py
+++ b/exo/main.py
@@ -186,7 +186,7 @@ async def main():
     await asyncio.Event().wait()
 
 
-if __name__ == "__main__":
+def run():
   loop = asyncio.new_event_loop()
   asyncio.set_event_loop(loop)
   try:
@@ -196,3 +196,6 @@ if __name__ == "__main__":
   finally:
     loop.run_until_complete(shutdown(signal.SIGTERM, loop))
     loop.close()
+
+if __name__ == "__main__":
+  run()
diff --git a/setup.py b/setup.py
index 8044f46d..67bd1974 100644
--- a/setup.py
+++ b/setup.py
@@ -55,4 +55,5 @@ setup(
   packages=find_packages(),
   install_requires=install_requires,
   extras_require=extras_require,
+  entry_points={"console_scripts": ["exo = exo.main:run"]},
 )

← 6abf4877 move main.py script to package dir  ·  back to Exo  ·  add missing __init__.py files 31e4454b →