diff --git a/README.md b/README.md index 696880c..19957bd 100644 --- a/README.md +++ b/README.md @@ -8,25 +8,13 @@ > ⚠ This is the start of the Python client for Speckle 2.0. It is currently quite nebulous and may be trashed and rebuilt at any moment! It is compatible with Python 3.6+ ⚠ ## Developing & Debugging +This project uses python-poetry for dependency management, make sure you follow the official [docs](https://python-poetry.org/docs/#installation) to get poetry. -To get started, create a virtual environment and pip install the requirements. - -on windows: -``` -python -m venv venv -venv\Scripts\activate -pip install -r requirements.txt -``` - -on mac: - -``` -python -m venv venv -source venv/bin/activate -pip install -r requirements.txt -``` +To bootstrap the project environment run `$ poetry install`. This will create a new virtual-env for the project and install both the package and dev dependencies. +To execute any python script run `$ poetry run python my_script.py` +> Alternatively you may roll your own virtual-env with either venv, virtualenv, pyenv-virtualenv etc. Poetry will play along an recognize if it is invoked from inside a virtual environment. ## Overview of functionality diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 6aef21b..0000000 --- a/requirements.txt +++ /dev/null @@ -1,31 +0,0 @@ -aiohttp==3.7.1 -appdirs==1.4.4 -astroid==2.4.2 -async-timeout==3.0.1 -attrs==20.3.0 -black==20.8b1 -certifi==2020.11.8 -chardet==3.0.4 -click==7.1.2 -colorama==0.4.4 -gql==3.0.0a4 -graphql-core==3.1.2 -idna==2.10 -isort==5.6.4 -lazy-object-proxy==1.4.3 -mccabe==0.6.1 -multidict==5.0.0 -mypy-extensions==0.4.3 -pathspec==0.8.1 -pydantic==1.7.2 -pylint==2.6.0 -regex==2020.11.11 -requests==2.24.0 -six==1.15.0 -toml==0.10.2 -typed-ast==1.4.1 -typing-extensions==3.7.4.3 -urllib3==1.25.11 -websockets==8.1 -wrapt==1.12.1 -yarl==1.5.1