Merge pull request #3 from SquareFactory/AR-100_change_cli_name

Ar 100 change cli name

Author: Emil Gelfort

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 
+## [0.4.2] - 2022.07.06
+
+### Improvements
+- doc improvement for release
+- name change to avoid confusions
+
 
 ## [0.4.1] - 2022.02.17
 

README.md

@@ -39,13 +39,13 @@ End-to-end guidelines on the code adaptation required to deploy a model on isqua
 To verify if your code will run smoothly on [ISquare](isquare.ai), you can perform a local build & unit test. This will build a container image with all your specific dependencies and perform an inference test. We've included an example of a simple computer vision model which returns the mirrored image it is given, and it can be tested by running:
 
 ```bash
- i2 build examples/tasks/mirror.py
+ i2py build examples/tasks/mirror.py
 ```
 When you deploy a model with [ISquare](isquare.ai), you will be provided a url for the model, and requested to create access keys. Using a valid url & access keys (the one displayed are an example), you can perform an inference with an Image model (e.g. the Mirror) and a `.png` image by running:
 
 
 ```bash
-i2 infer \
+i2py infer \
   --url wss://archipel-beta1.isquare.ai/43465956-8d6f-492f-ad45-91da69da44d0 \
   --access_uuid 48c1d60a-60fd-4643-90e4-cd0187b4fd9d \
   examples/test.png

docs/commands.md

@@ -1,9 +1,9 @@
 # i2
 
-`i2`, for isquare, is the name of the general command used for the client:
+`i2py`, for isquare python client, is the name of the general command used for the client:
 
 ```bash
-Usage: i2 [OPTIONS] COMMAND [ARGS]...
+Usage: i2py [OPTIONS] COMMAND [ARGS]...
 
   Command line interface for isquare.
 
@@ -19,7 +19,7 @@ Commands:
 ## build
 
 ```bash
-Usage: i2 build [OPTIONS] SCRIPT
+Usage: i2py build [OPTIONS] SCRIPT
 
   Build an docker image ready for isquare.
 
@@ -46,7 +46,7 @@ If you just want to test an image without rebuilding it completely you can just
 following command:
 
 ```bash
-Usage: i2 test [OPTIONS] TAG
+Usage: i2py test [OPTIONS] TAG
 
   Verify that an docker image matches the isquare standard.
 
@@ -57,10 +57,10 @@ Options:
 
 ## infer
 
-The `i2 infer` command is used to send the data to your models running on isquare:
+The `i2py infer` command is used to send the data to your models running on isquare:
 
 ```bash
-Usage: i2 infer [OPTIONS] DATA
+Usage: i2py infer [OPTIONS] DATA
 
   Send data for inference.
 

docs/getting_started.md

@@ -22,7 +22,7 @@ The client allows you to build and test your model before uploading it to isquar
 you to test this feature, which we are sure will save you alot of time. For instance, try running:
 
 ```bash
-i2 build examples/tasks/mirror.py --cpu
+i2py build examples/tasks/mirror.py --cpu
 ```
 You should see following output:
 

setup.py

@@ -27,11 +27,12 @@
         "numpy>=1.19",
         "rich>=10.13",
         "websockets>=8.1",
+        "opencv-python==4.6.0.66",
     ],
     packages=find_packages(),
     entry_points="""
         [console_scripts]
-        i2=i2_client:i2_cli
+        i2py=i2_client:i2_cli
     """,
     python_requires=">=3.8",
 )