A client library for accessing The Jira Cloud platform REST API
Project description
openapi-jira-client
A client library for accessing The Jira Cloud platform REST API
Usage
First, create a client:
from openapi_jira_client import Client
client = Client(base_url="https://api.example.com")
If the endpoints you're going to hit require authentication, use AuthenticatedClient
instead:
from openapi_jira_client import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
Now call your endpoint and use your models:
from openapi_jira_client.models import MyDataModel
from openapi_jira_client.api.my_tag import get_my_data_model
from openapi_jira_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 openapi_jira_client.models import MyDataModel
from openapi_jira_client.api.my_tag import get_my_data_model
from openapi_jira_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
openapi_jira_client.api.default
Building / publishing this Client
This project uses Poetry to manage dependencies and packaging. Here are the basics:
- Update the metadata in pyproject.toml (e.g. authors, version)
- If you're using a private repository, configure it with Poetry
poetry config repositories.<your-repository-name> <url-to-your-repository>
poetry config http-basic.<your-repository-name> <username> <password>
- Publish the client with
poetry publish --build -r <your-repository-name>
or, if for public PyPI, justpoetry publish --build
If you want to install this client into another project without publishing it (e.g. for development) then:
- If that project is using Poetry, you can simply do
poetry add <path-to-this-client>
from that project - If that project is not using Poetry:
- Build a wheel with
poetry build -f wheel
- Install that wheel from the other project
pip install <path-to-wheel>
- Build a wheel with
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openapi-jira-client-3.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3834bf220e416321c87179a1b85ae2f1bee8277f910d8b0b84ad8d657518c100 |
|
MD5 | 5a683651488073ca2cf8acab4c794c52 |
|
BLAKE2b-256 | 248b0aeb4886ede077611b3f5d7e887833f01437516220092c068c8e7106d212 |
Hashes for openapi_jira_client-3.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90467bc3af2da72269e1de90bd8f19fae1a54ac58e376fa1a7e5bedca39f184c |
|
MD5 | d64f3489a392a58781d4e7f396b7fdcc |
|
BLAKE2b-256 | d8fa52e3c15efef112f047bd8057604570ba9e50c67c8578c4aa2ec364641872 |