: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
Unreleasedwith 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
VERSIONvar insetup.pymatching 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
publishstep.
License
Metadata
Release files for pyopencell 0.4.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyopencell-0.4.10.tar.gz | 21.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyopencell-0.4.10-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 48.8 kB
Release files / pyopencell-0.4.10.tar.gz
| Download URL | pyopencell-0.4.10.tar.gz |
|---|---|
| Size | 21.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d09b90655260c7c1e88403d90d479f276caaad62266c18196ca9abfeb36090d2
|
|
BLAKE2b-256 checksum How to use checksums |
f65fc6e350322fdc29aa79273320bae46fdc4ae8081c27d2877b25a9df49f7d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.17
|
Release files / pyopencell-0.4.10-py2.py3-none-any.whl
| Download URL | pyopencell-0.4.10-py2.py3-none-any.whl |
|---|---|
| Size | 26.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
064e8e9830d3f4233c370a60240483f4c7c108e99f79aac71c483373b4508017
|
|
BLAKE2b-256 checksum How to use checksums |
eda843fba42ec7a8fffa5fa0124e64ec796e0847ec07c87ec1c60c97d63c5933
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.17
|