PyTrengo

PyTrengo is a lightweight Python client for the Trengo API.

Note: PyTrengo is not affiliated nor endorsed by Trengo.

Install

With pip:

pip install pytrengo

With Poetry:

poetry add pytrengo

Requirement: Python 3.10+

Usage

from trengo import Trengo

trengo_client = Trengo(token="...")

# If the token is not provided, it’s read from the TRENGO_TOKEN environment variable
trengo_client = Trengo()

for ticket in trengo_client.get_tickets():
    print(...)

List queries are transparently paginated for you.

Endpoints coverage

Note: even if an endpoint is not implemented, you can call it with one of the helper methods:

# GET /v2/some-endpoints?foo=bar
trengo_client.get_json_api("/some-endpoint", params={"foo": "bar"})
# POST /v2/some-other-endpoint with {"foo": "bar"}
trengo_client.post_json_api("/some-other-endpoint",
                            json={"foo": "bar"})

Naming

• Methods for API endpoints like "List s" are named get_<name>s
• Methods for API endpoints like "Get " or "View " are named get_<name>
• We try to stay consistent even when the API isn’t: the field for the relations to include is always named include in PyTrengo, while the API uses include in some calls and with in some others

License

Copyright 2024 Bixoto.