A simple client to access Teamscale's REST API written in Python
Find the documentation here: http://cqse.github.io/teamscale-client-python
Caution
The Teamscale Python Client is deprecated since February 2024. If you need to interact with Teamscale's REST API using Python (or any other programming language), we recommend that you generate an appropriate client from the OpenAPI specification accessible within Teamscale (? > API Reference > OpenAPI specification). This approach offers two benefits: You get full access to Teamscale's extensive REST API and you are not restricted to Python but can use a programming language of your choice.
We recommend to use at least Python 3.7 for running the Teamscale Python Client. Install from PyPi:
pip install teamscale-client
Alternatively, you can install from source by cloning the repository and executing:
pip install .
Copy the file examples/.teamscale-client.config into your home directory and update it to reflect your setup.
This way, you can easily create the TeamscaleClient from the configuration
file via a TeamscaleClientConfig.
To get an overview on common usage scenarios, please have a look
at the examples folder of this repository.
To install all required dependencies for running tests and developing the client, create a new environment and execute:
pip install -r requirements.txt
We are happy to add additional service calls to the client. Please make sure you include a test, if you add a service call. To run them use:
python setup.py test
Tests are written using the responses library, to mock the requests passed to the server using the requests api.