Python 2.7/3.8 module to manage the SomConnexio's ERP integration with OTRS
This library manages all the business logic between the Som Connexio's systems and the ticketing tool OTRS.
Processes
OTRS Configuration
Configure the web services in OTRS:
Ticket Connector (Provider)
-
Usage: It exposes the Ticket, Article and DynamicFields object and allows to get, create, update and remove tickets. We use the PyOTRS to interact with it. Look in the PyOTRS docs for more info.
-
Configuration: Use the template provided by the PyOTRS client: https://gitlab.com/rhab/PyOTRS/-/blob/master/webservices_templates/GenericTicketConnectorREST.yml
CustomerUser Connector (Provider)
-
Usage: It's a RPCConnector. It interacts with the OTRS objects directly calling the class methods.
-
Configuration: You need admin permissions to manage it. Contact with your OTRS provider.
MMCaller Connector (Requester)
-
Usage: It calls MMProxy when an event is raised.
-
Configuration: https://gitlab.com/coopdevs/somconnexio-documentation/-/blob/master/integracions/masmovil.md#webservice-dotrs
Environment configuration
OTRSClient
The client to interact with OTRS. You need to define the next environment variables to use the client:
OTRS_URL= # Baseurl of the OTRS instance
OTRS_USER= # Creadencials of user with write acces to OTRS
OTRS_PASSW=
Python version
We are using Pyenv to fix the Python version and the virtualenv to test the package.
You need:
- Intall and configure
pyenv - Install and configure
pyenv-virtualenvwrapper - Intall locally the version of python needed:
$ pyenv install 3.8.2
- Create the virtualenv to use:
$ pyenv virtualenv 3.8.2 otrs_somconnexio
Python packages requirements
Install the Python packages in the virtual environment:
$ pyenv exec pip install -r requirements.txt
Run tests
To run the test you can run:
$ tox
Also you can run only the tests running:
$ pytest .
and if you want the coverage info:
$ pytest --cov .
If running the tests with tox, they will be tested with both python3.8 and python2.7. This is because OTRS-SomConnexio works with an ERP which uses python2, as well as with other packages that use python3.
Release process
Release and publish the package to PyPi:
- Update the VERSION var in setup.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 the Deployments > Releases section and push it.
- Once the pipeline has successfully passed, approve the publish step.
2 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file otrs_somconnexio-0.8.6.tar.gz.
File metadata
- Download URL: otrs_somconnexio-0.8.6.tar.gz
- Upload date:
- Size: 75.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.8.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ae2978836fd644b0ae81300c7fa8df5c91fade374c0ee303c6d4b848ce10241
|
|
| MD5 |
3276f6ed71fbcf2e927143d277d2d334
|
|
| BLAKE2b-256 |
092001dacf748b78036e27655b1f54709cd86b8b1535e25f97e624e5665976dd
|
File details
Details for the file otrs_somconnexio-0.8.6-py2.py3-none-any.whl.
File metadata
- Download URL: otrs_somconnexio-0.8.6-py2.py3-none-any.whl
- Upload date:
- Size: 151.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.8.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f9b281a571a667a65871c7f3105943965d27a0f68ce91ea9f340871fca4f93e2
|
|
| MD5 |
9341f34a8dec56eb995c1f95b7b5886d
|
|
| BLAKE2b-256 |
98cc4438d5cf9cf915e657c88c1c3a02ab8c32e3e6682f4f81f3aaa9c5c7b97b
|
