A client library for accessing YouTrack REST API
Project description
youtrack-rest-client 0.1.1
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.1.tar.gz
(91.8 kB
view hashes)
Built Distribution
Close
Hashes for youtrack-rest-client-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2626b3ae7fbb172ad715e1f29c1e0606134d9707fd1680212a3609d8368985fb |
|
MD5 | 63cd1db7d9cccd0bfc5fc1d30da6528f |
|
BLAKE2b-256 | 3131523ca97b153d4a2e33498664f20c64383de8e10c137c441f67c3456c61d9 |
Close
Hashes for youtrack_rest_client-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 403e1e040b7cf7b35330facca05857629b5607e73f0e39bcf551f960b013a78d |
|
MD5 | f233f3bb6ae6ecea6983ffc6000bcf09 |
|
BLAKE2b-256 | 05561263e7b5eb551c1777269c9dbaef609a4e3ac5627de84b0405cda1e7eedb |