A package to easily download and manipulate the lcss case datasets
Project description
A wrapper around the case-repository API currently hosted at lcsscaseapi.duckdns.org (if this changes you need to chang the domain name in lcsscaseapi/constants.py
).
Any use of the wrapper begins by initializing an LCSSClient object (defined in lcsscaseapi/client.py
). This requires supplying a valid username and password. After this, requests can be made using methods of the object, and will return objects of types specified in lcsscaseapi/types.py
.
Warning: Do not write the username and password supplied to the LCSSClient object in code that is committed to a repository. Fetch these details instead from environmental variblaes. Otherwise anyone reading your repository can access the API
Testing uses pytest and requests-mocker and tests are located in the tests/
directory.
Publishing to Pypi
To publish new versions, change the version number in setup.cfg, generate a new distribution and upload it to twine. See here: https://packaging.python.org/tutorials/packaging-projects/
To be precise, run python3 -m build
. Then run twine upload dist/*
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lcsscaseapi-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f11969707aa91cc51902a686903ad3a177a89a82e5da0cee864e15aea2d75a22 |
|
MD5 | 70405db71a8978d69fa7cc7ad88a7ef7 |
|
BLAKE2b-256 | 86e94cb937b9fd387fe3f0037950d151be7beaf2fa0d7efac1923c82019a87be |