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.
Be sure that your MR was merged in to master
and that you have the needed permissions to create a tag and to push to master
branch. Then, follow the next steps:
- Checkout to
master
and pull the changes
$ git checkout master
$ git pull
- Update the
CHANGELOG.md
file. Modify theUnreleased
header to point to the new version as is indicated in keepchangelog.com. - Update the
VERSION
var in thesetup.py
file. - Add, commit and push the changes:
$ git add CHANGELOG.md setup.py
$ git commit -m "Bump to 0.x.y"
$ git push
- Run the update:
$ python setup.py upload
It will create a git tag for the version indicated in VERSION
variable in setup.py
and run a pipeline to deploy the package in PyPI.
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.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bff822054c893f51907db734675c69ba8ba53f8b3dca3e8f7d08f4f8375311ad |
|
MD5 | 124b305f1da8ec1c2b8408521a9b3d37 |
|
BLAKE2b-256 | 5cffb5e4f5b43b7b829e209b8c824514b32902018a3eab44a32619dfd9bfd45f |