A client library for accessing YouTrack REST API
Project description
youtrack-rest-client 0.1.5
A client library for accessing YouTrack REST API
⚠️This SDK generated using 2021.3
OpenAPI version by custom openapi-python-client which is under development.
It may have some bugs. Use with caution.⚠️
If you find a bug or want to request a new feature, please create an issue in YouTrack.
Usage
First, create a client:
from youtrack_rest_client import Client
client = Client(
hub_base_url="https://hub.jetbrains.com/api/rest",
youtrack_base_url="https://youtrack.jetbrains.com/api"
)
If the endpoints you're going to hit require authentication, use AuthenticatedClient
instead:
from youtrack_rest_client import AuthenticatedClient
client = AuthenticatedClient(
hub_base_url="https://hub.jetbrains.com/api/rest",
youtrack_base_url="https://youtrack.jetbrains.com/api",
token=os.getenv("YOUTRACK_TOKEN")
)
Now call your endpoint and use your models:
from youtrack_rest_client.models import MyDataModel
from youtrack_rest_client.api.my_tag import get_my_data_model
from youtrack_rest_client.types import Response
my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
Or do the same thing with an async version:
from youtrack_rest_client.models import MyDataModel
from youtrack_rest_client.api.my_tag import get_my_data_model
from youtrack_rest_client.types import Response
my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
Things to know:
- Every path/method combo becomes a Python module with four functions:
sync
: Blocking request that returns parsed data (if successful) orNone
sync_detailed
: Blocking request that always returns aRequest
, optionally withparsed
set if the request was successful.asyncio
: Likesync
but the async instead of blockingasyncio_detailed
: Likesync_detailed
by async instead of blocking
- All path/query params, and bodies become method arguments.
- If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
- Any endpoint which did not have a tag will be in
youtrack_rest_client.api.default
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
youtrack-rest-client-0.1.5.tar.gz
(92.4 kB
view hashes)
Built Distribution
Close
Hashes for youtrack-rest-client-0.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ae90610e0ad02bf9ca5a0e95f3c19cb697594d37bb05362b8427db49ccf3e7a |
|
MD5 | f537ee82f07db11be66a50c5bec10e82 |
|
BLAKE2b-256 | 472b228cef89b1d1fcfa818ea5768632815cd059b2359bdaac90569677ecbdf1 |
Close
Hashes for youtrack_rest_client-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9b19c64a26a2f6e06b45f876af613b5703a53faab8eb2b5b5e036efd5810fe2 |
|
MD5 | cee032b604a9cda8d9673a36fd60baa7 |
|
BLAKE2b-256 | 12c2dc782f4dead3c2631ea986d3feb938442fde412bed36bc67471120589ac1 |