Merge pull request #6 from kornia/update_readme

Update readme
kornia · Feb 13, 2023 · f0e719f · f0e719f
2 parents 4ad43df + 9c1918f
commit f0e719f
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 14 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,11 +17,11 @@ jobs:
       run: python3 -m pip install -e .
     - name: Build distribution package
       run: python3 setup.py sdist bdist_wheel
-    - name: Publish package to 📦 Test PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        password: ${{ secrets.PYPI_TEST_PASSWORD_LIMBUS }}
-        repository_url: https://test.pypi.org/legacy/
+  #  - name: Publish package to 📦 Test PyPI
+  #    uses: pypa/gh-action-pypi-publish@release/v1
+  #    with:
+  #      password: ${{ secrets.PYPI_TEST_PASSWORD_LIMBUS }}
+  #      repository_url: https://test.pypi.org/legacy/
     - name: Publish distribution 📦 to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:

diff --git a/README.md b/README.md
@@ -88,22 +88,25 @@ MyApp().run(1)
 
 ## Installation
 
-from PyPI:
+### from PyPI:
 ```bash
 pip install limbus  # limbus alone
 # or
 pip install limbus[components]  # limbus + some predefined components
 ```
 
-from the repository:
+### from the repository:
 
 ```bash
 pip install limbus@git+https://git@github.com/kornia/limbus.git  # limbus alone
 # or
 pip install limbus[components]@git+https://git@github.com/kornia/limbus.git  # limbus + some predefined components
 ```
 
-For development purposes, you can install the environment with the following commands:
+### for development
+
+you can install the environment with the following commands:
+
 ```bash
 git clone https://github.com/kornia/limbus
 cd limbus
@@ -114,6 +117,7 @@ In order to regenerate the development environment:
 ```bash
 cd limbus
 rm -rf .dev_env
+source path.bash.inc
 ```
 
 ## Testing

diff --git a/examples/default_cmps.py b/examples/default_cmps.py
@@ -7,8 +7,8 @@
 try:
     import limbus_components as components
 except ImportError:
-    raise ImportError("limbus-components is required to run this script. Reinstall limbus with: "
-                      "'pip install limbus[components]' or install the package with: "
+    raise ImportError("limbus-components is required to run this script."
+                      "Install the package with: "
                       "'pip install limbus-components@git+https://git@github.com/kornia/limbus-components.git'")
 
 

diff --git a/examples/webcam_app.py b/examples/webcam_app.py
@@ -11,8 +11,8 @@
 try:
     import limbus_components as components
 except ImportError:
-    raise ImportError("limbus-components is required to run this script. Reinstall limbus with: "
-                      "'pip install limbus[components]' or install the package with: "
+    raise ImportError("limbus-components is required to run this script."
+                      "Install the package with: "
                       "'pip install limbus-components@git+https://git@github.com/kornia/limbus-components.git'")
 
 # Init the widgets backend

diff --git a/setup.py b/setup.py
@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 setup(name='limbus',
-      version='0.1.0.dev',
+      version='0.1.1.dev',
       description='High level interface to create Pytorch Graphs.',
       long_description=open('README.md').read(),
       long_description_content_type='text/markdown',
@@ -29,7 +29,7 @@
               'pep8-naming',
           ],
           'components': [
-              'limbus-components@git+https://git@github.com/kornia/limbus-components.git'
+              'limbus-components'
           ]
       },
       packages=find_packages(where='.'),