Skip to content

geobeyond/anncsu-sdk

BranchesTags

Repository files navigation

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())

Security and Authentication

All ANNCSU APIs use PDND (Piattaforma Digitale Nazionale Dati) voucher-based authentication with HTTP Bearer tokens.

Basic Authentication

from anncsu.pa import Anncsu
from anncsu.common import Security

# Create security configuration with your PDND voucher
security = Security(bearer="your-pdnd-voucher-token")

# Initialize SDK with security
sdk = Anncsu(security=security)

# Make authenticated requests
response = sdk.queryparam.esiste_odonimo_get_query_param(
    codcom="H501",
    denom="VklBIFJPTUE="
)

Key Features

  • PDND Voucher: Uses PDND (Piattaforma Digitale Nazionale Dati) authentication
  • Bearer Token: JWT format tokens in Authorization header
  • Common Security: Same Security class works across all ANNCSU APIs
  • Type-Safe: Full type hints with modern Python syntax

Generating Client Assertions Programmatically

The SDK includes a built-in module for generating PDND client assertions (JWT tokens) at runtime:

from anncsu.common import ClientAssertionConfig, create_client_assertion

# Option 1: With private key as bytes
config = ClientAssertionConfig(
    kid="your-key-id",
    issuer="your-client-id",
    subject="your-client-id",
    audience="https://auth.interop.pagopa.it/token.oauth2",
    purpose_id="your-purpose-id",
    private_key=b"-----BEGIN RSA PRIVATE KEY-----\n...",
)
token = create_client_assertion(config)

# Option 2: With private key file path
from pathlib import Path

config = ClientAssertionConfig(
    kid="your-key-id",
    issuer="your-client-id",
    subject="your-client-id",
    audience="https://auth.interop.pagopa.it/token.oauth2",
    purpose_id="your-purpose-id",
    key_path=Path("./private_key.pem"),
)
token = create_client_assertion(config)

# Use the token with the SDK
from anncsu.common import Security

security = Security(bearer=token)
sdk = Anncsu(security=security)

Loading Configuration from Environment Variables

The SDK supports loading configuration from environment variables or a .env file:

from anncsu.common.config import ClientAssertionSettings
from anncsu.common import create_client_assertion, Security
from anncsu.pa import Anncsu

# Automatically loads from environment variables or .env file
settings = ClientAssertionSettings()
token = create_client_assertion(settings.to_config())

# Use with SDK
security = Security(bearer=token)
sdk = Anncsu(security=security)

Required Environment Variables (prefix: PDND_)

Variable Description
PDND_KID Key ID (kid) header parameter
PDND_ISSUER Issuer claim - your client_id
PDND_SUBJECT Subject claim - your client_id
PDND_AUDIENCE Audience claim - PDND token endpoint
PDND_PURPOSE_ID Purpose ID for the request
PDND_PRIVATE_KEY Private key content (or use PDND_KEY_PATH)
PDND_KEY_PATH Path to private key file (or use PDND_PRIVATE_KEY)

Example .env file

PDND_KID=my-key-id
PDND_ISSUER=my-client-id
PDND_SUBJECT=my-client-id
PDND_AUDIENCE=https://auth.interop.pagopa.it/token.oauth2
PDND_PURPOSE_ID=my-purpose-id
PDND_KEY_PATH=./private_key.pem

Documentation

For comprehensive security documentation including:

  • PDND voucher format and JWT structure
  • Client assertion generation
  • Token refresh strategies
  • Error handling (401/403)
  • Best practices and security checklist
  • Testing with security

See docs/SECURITY.md

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.common.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.common.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.

Architecture

This SDK follows a modular architecture designed to support multiple ANNCSU API specifications:

Package Structure

anncsu/
├── common/          # Shared infrastructure (utilities, types, HTTP client, base errors)
└── pa/              # API-specific: Consultazione per le PA
    ├── models/      # Request/response models
    ├── errors/      # Operation-specific errors
    └── sdk.py       # Main SDK class

Shared Components (anncsu.common)

The anncsu.common package contains shared primitives used across all ANNCSU API clients:

  • Types: Base models and type definitions (BaseModel, OptionalNullable, UNSET)
  • Utilities: 16 utility modules for HTTP operations, serialization, retry logic, etc.
  • HTTP Infrastructure: HTTP client wrappers, base SDK class, configuration
  • Hooks: Before/after request hooks for customization
  • Base Errors: Generic error classes (AnncsuBaseError, APIError, NoResponseError)

Using Shared Components

When using advanced features like retry configuration, import from anncsu.common:

from anncsu.pa import Anncsu
from anncsu.common.utils import BackoffStrategy, RetryConfig  # Shared utilities

For regular SDK usage, you only need to import from anncsu.pa:

from anncsu.pa import Anncsu  # All you need for basic usage

Multiple API Support

This architecture allows adding new ANNCSU API specifications (e.g., aggiornamento_accessi, coordinate, interni, odonimi) as separate packages under the anncsu namespace, all sharing the same infrastructure.

For more details, see Refactoring Documentation.

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

Development/Validation Environment

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

Note

Production environment specification will be available in oas/prod/ when provided by Agenzia delle Entrate.

About

ANNCSU Software Development Kit for API consumption

Resources

Readme

License

MIT license

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages