ANNCSU Software Development Kit for API consumption

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for geobeyond from gravatar.com geobeyond

Unverified details

These details have not been verified by PyPI
Meta
Report project as malware

Project description

anncsu-sdk

ANNCSU Software Development Kit for API consumption

Developer-friendly & type-safe Python SDK specifically catered to leverage anncsu API.



[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

ANNCSU REST API: API dei servizi REST di ANNCSU su PDND

Table of Contents

SDK Installation

[!TIP] To finish publishing your SDK to PyPI you must run your first generation action.

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from anncsu.pa python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "anncsu",
# ]
# ///

from anncsu.pa import Anncsu

sdk = Anncsu(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

SDK Example Usage

Example

# Synchronous Example
from anncsu.pa import Anncsu


with Anncsu() as a_client:

    res = a_client.queryparam.esiste_odonimo_get_query_param(codcom="H501", denom="VklBIFJPTUE=")

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
from anncsu.pa import Anncsu
import asyncio

async def main():

    async with Anncsu() as a_client:

        res = await a_client.queryparam.esiste_odonimo_get_query_param_async(codcom="H501", denom="VklBIFJPTUE=")

        # Handle response
        print(res)

asyncio.run(main())

Available Resources and Operations

Available methods

json_post

pathparam

queryparam

status

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from anncsu.pa import Anncsu
from anncsu.pa.utils import BackoffStrategy, RetryConfig


with Anncsu() as a_client:

    res = a_client.queryparam.esiste_odonimo_get_query_param(codcom="H501", denom="VklBIFJPTUE=",
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from anncsu.pa import Anncsu
from anncsu.pa.utils import BackoffStrategy, RetryConfig


with Anncsu(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as a_client:

    res = a_client.queryparam.esiste_odonimo_get_query_param(codcom="H501", denom="VklBIFJPTUE=")

    # Handle response
    print(res)

Error Handling

AnncsuError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
err.message str Error message
err.status_code int HTTP response status code eg 404
err.headers httpx.Headers HTTP response headers
err.body str HTTP body. Can be empty string if no body is returned.
err.raw_response httpx.Response Raw HTTP response
err.data Optional. Some errors may contain structured data. See Error Classes.

Example

from anncsu.pa import Anncsu, errors


with Anncsu() as a_client:
    res = None
    try:

        res = a_client.queryparam.esiste_odonimo_get_query_param(codcom="H501", denom="VklBIFJPTUE=")

        # Handle response
        print(res)


    except errors.AnncsuError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.EsisteOdonimoGetQueryParamBadRequestError):
            print(e.data.title)  # Optional[str]
            print(e.data.detail)  # Optional[str]

Error Classes

Primary error:

  • AnncsuError: The base class for HTTP error responses.
Less common errors (120)

Network errors:

Inherit from AnncsuError:

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from anncsu.pa import Anncsu


with Anncsu(
    server_url="https://modipa.agenziaentrate.gov.it/govway/rest/in/AgenziaEntrate-PDND/anncsu-consultazione/v1",
) as a_client:

    res = a_client.queryparam.esiste_odonimo_get_query_param(codcom="H501", denom="VklBIFJPTUE=")

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from anncsu.pa import Anncsu
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Anncsu(client=http_client)

or you could wrap the client with your own custom logic:

from anncsu.pa import Anncsu
from anncsu.pa.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Anncsu(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Anncsu class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from anncsu.pa import Anncsu
def main():

    with Anncsu() as a_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Anncsu() as a_client:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from anncsu.pa import Anncsu
import logging

logging.basicConfig(level=logging.DEBUG)
s = Anncsu(debug_logger=logging.getLogger("anncsu"))

You can also enable a default debug logger by setting an environment variable ANNCSU_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

Validate the specifications

spectral lint oas/Specifica\ API\ -\ ANNCSU\ –\ Consultazione\ per\ le\ PA.yaml --ruleset oas/.spectral.yaml

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for geobeyond from gravatar.com geobeyond

Unverified details

These details have not been verified by PyPI
Meta

Release history Release notifications | RSS feed

0.0.8

0.0.8.dev1 pre-release

0.0.7

0.0.7.dev2 pre-release

0.0.7.dev1 pre-release

0.0.6

0.0.5

0.0.4

This version

0.0.3

0.0.2

0.0.1

0.0.1.dev32 pre-release

0.0.1.dev31 pre-release

0.0.1.dev30 pre-release

0.0.1.dev28 pre-release

0.0.1.dev24 pre-release

0.0.1.dev21 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anncsu_sdk-0.0.3.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anncsu_sdk-0.0.3-py3-none-any.whl (92.6 kB view details)

Uploaded Python 3

File details

Details for the file anncsu_sdk-0.0.3.tar.gz.

File metadata

  • Download URL: anncsu_sdk-0.0.3.tar.gz
  • Upload date:
  • Size: 55.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for anncsu_sdk-0.0.3.tar.gz
Algorithm Hash digest
SHA256 ebb1632e0c596cf4763674e0664355dab21caedfa14c0019cb1b5dc0451d3566
MD5 79a235cc28010b6194035826e784e35e
BLAKE2b-256 1ad1dcd1545559c2104d5205e903868de3eac49f427e791f6f8e1c2d7ac39fc7

See more details on using hashes here.

File details

Details for the file anncsu_sdk-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: anncsu_sdk-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 92.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for anncsu_sdk-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1e12b40a945a8f599daee3ebc3e473b4b47decdce5da7c1132660612f72eefcd
MD5 3c6abd8d5c3d9e31bad3329eacc080a2
BLAKE2b-256 8eb34823167a86ec6245645d45d304b90153eec4922e0dcdeeb8f8d97bb4d8d9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page