README.md

Cupid Python Wrapper

This is a wrapper written in Python for the Cupid API.

Development

To work on this wrapper, you will need Pipenv (as well as Python 3.9+). Pipenv can be installed through PyPI, for example python3 -m pip install pipenv.

Once you have pipenv installed:

1. Create a virtual environment: python3 -m pipenv shell
2. Install development dependencies: pipenv install -d
3. Lint the project: pipenv run lint
4. Run unit tests: pipenv run test
5. Build the docs: pipenv run docs