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
Create a virtualenv before installing dependencies.
If you are using virtualenvwrapper
(https://virtualenvwrapper.readthedocs.io/en/latest/).
- Create virtualenv with python 3.7.7
$ which python
/usr/bin/python3.7
$ 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
Update CHANGELOG.md following this steps:
- Add any entries missing from merged merge requests.
- Duplicate the
[Unreleased]
header. - Replace the second
Unreleased
with a version number followed by the current date. Copy the exact format from previous releases.
Then, you can release and publish the package to PyPi:
- Update the
VERSION
var insetup.py
matching the version you specified in the CHANGELOG. - Open a merge request with these changes for the team to approve
- Merge it, add a git tag on that merge commit and push it.
- Once the pipeline has successfully passed, go approve the
publish
step.
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.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7be725e76388b13d5054cf3b1708fd6604f57ef1c5266cf1702ae4bf661e2387 |
|
MD5 | 1f3b77c177d6397011d9d4e26622d7a9 |
|
BLAKE2b-256 | 561b60dc095038455967c286d84bf879d972ecd5193bf2c777e62f5b3be76058 |