Skip to content

cms-cat/order

Repository files navigation

Documentation status Python version Package version License Lint and test Code coverge Open in colab

Pythonic class collection to structure and access CMS metadata.

TODO: introduction

Getting started

TODO: Add intro notebook.

You can find the full API documentation on readthedocs.

Installation

Install order via pip:

pip install order

Contributing

If you like to contribute, feel free to open a pull request 🎉.

venv

It is recommended to create a Python virtual environment (using venv) and install the development requirements.

python -m venv .env/order
source .env/order/bin/activate
pip install -U pip setuptools
pip install .[dev]

Testing

After making changes, make sure to run test cases and linting checks.

./tests/test.sh
./tests/lint.sh

Development

Setup the environment:

export ORDER_CLEAR_CACHE=True                                          
export ORDER_DATA_LOCATION='/path/to/order-data'
export X509_USER_PROXY=your-cert-file

About

Tools for accessing CMS Metadata

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published