Skip to main content

A light Python wrapper around the METRC Web API

Project description

Python METRC

A light Python wrapper around the METRC Web API

https://img.shields.io/pypi/v/python_metrc.svg https://img.shields.io/travis/DigiThinkIT/python-metrc.svg

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

$ pip install python_metrc

Running the tests

cd python_metrc
pytest

Documentation

To generate and call the endpoint - https://sandbox-api-ca.metrc.com/transfers/v1/delivery/packages/states - you can use any of the following combinations:

>>> from python_metrc import METRC
>>> metrc = METRC('https://sandbox-api-ca.metrc.com', vendor_key={VENDOR_KEY}, user_key={USER_KEY}, license_number={LICENSE_NUMBER})
>>> metrc.transfers('delivery').packages('states').get()
<Response [200]>
>>> metrc.transfers.delivery.packages('states').get()
<Response [200]>
>>> metrc.transfers.delivery.packages.states.get()
<Response [200]>
>>> metrc.transfers('delivery', 'packages', 'states').get()
<Response [200]>

The METRC class instance provides the GET, POST and DELETE HTTP methods as binded on itself. The return type is the requests module’s Response object.

Contributing

Please read the Contribution guidelines for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

  • Hammock - Used to generate RESTful URLs

History

0.1.2 (2018-09-26)

  • Convert main class to inherit from Hammock instead.

0.1.1 (2018-09-26)

  • Clean up unnecessary artefacts after setup.

0.1.0 (2018-09-26)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-metrc, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size python_metrc-0.1.4-py2.py3-none-any.whl (4.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size python_metrc-0.1.4.tar.gz (9.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page