Python wrapper for OpenCell (using REST API)
Project description
:heart: Inspired by PyOTRS :heart:
PyOpenCell is a Python wrapper for accessing Open Cell (Version 6) using the REST API.
You can see all the API information here
Features
Access an OpenCell instance to:
- find a Customer by ID
Installation
Dependencies
Yoy maybe want to create a virtualenv before installing dependencies.
If you are using virtualenvwrapper
(https://virtualenvwrapper.readthedocs.io/en/latest/).
- Create virtualenv with python 2.7
$ which python
/usr/bin/python
$ mkvirtualenv --python=/usr/bin/python pyopencell
If you are using pyenv with pyenv-virtualenv plugin:
$ pyenv virtualenv pyopencell
- Install requirements:
$ pip install -r requirements.txt
Configuration Environment
You need define the OpcenCell API credentials as environment variables. You need define:
OPENCELL_BASEURL=<YOUR OC HOST>/opencell
OPENCELL_USER=<YOUR OC USER>
OPENCELL_PASSWORD=<YOUR OC PASSWORD>
If this envvars are not defined, a exception will be raised with the name of the envvar not defined.
Python Usage
Run test suite
$ tox
Release process
You can upload a new version of pyopencell package to PyPI. First, you need to load the virtualenv where required python packages are installed. Then, run:
$ python setup.py upload
You will be prompted for credentials in PyPI.org.
It will create a git tag for the version indicated in VERSION
variable in setup.py
, and upload the package.
License
Project details
Release history Release notifications | RSS feed
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 pyopencell-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97e3b18bfe288223bb1f8c1d5f06838fea765e709f12147dde9659b2b25c075c |
|
MD5 | a748abe0dd0400556ef822693e38b127 |
|
BLAKE2b-256 | fcadb9007940c5f28911845473fc223b337dd6907ba658c34891d7bed511ec98 |