A client library for accessing YouTrack REST API
Project description
youtrack-rest-client 0.1.2
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.2.tar.gz
(94.5 kB
view hashes)
Built Distribution
Close
Hashes for youtrack-rest-client-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f28de670221b28aa1dca4eb6279b611913be583553f8625ff4ded8abbf28ea7 |
|
MD5 | 212eb156dbcabbb67b904bc0e58737d5 |
|
BLAKE2b-256 | 05f122c23e944f8708c29f969f47123fe8a2295c27bf0be7a31a0074047535ef |
Close
Hashes for youtrack_rest_client-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c181d1796edc6bcbc497026105359560e4b5cbc0b37d9efe9dc4d1ccf0e12ae |
|
MD5 | 3a9055acf9f8f5afd13a781a99d6fcef |
|
BLAKE2b-256 | 7bea2aba55cf1f8f4c74ed5c2d4628f386ce8d0cbe3cb61e548ec09879c7b62c |