DECAF API Client (Python)
TODO: Provide a complete README file.
Development
Create a virtual environment, if you did not create one before:
python3.9 -m venv /opt/venvs/decaf-client-python
Start Development
Activate the virtual environment:
. /opt/venvs/decaf-client-python/bin/activate
Upgrade pip
and setuptools
:
pip install --upgrade pip setuptools
Install pipenv
:
pip install pipenv
Install production and development dependencies:
pipenv install --dev
Run tests:
pipenv run tox
Open the codebase in VSCode:
code .
Build and Publish
Install/upgrade twine
:
pip install --upgrade twine
Build the source distribution:
python setup.py sdist bdist_wheel
Check the distribution(s):
twine check dist/*
Upload the distribution:
twine upload -s dist/*
License and Copyrights
This software is licensed under The 3-Clause BSD License.