Skip to main content

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

lcsscaseapi-0.0.6.tar.gz (6.2 kB view hashes)

Uploaded source

Built Distribution

lcsscaseapi-0.0.6-py3-none-any.whl (7.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page