| Name | aignostics JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | None |
| Summary | 🔬 Python SDK providing access to Aignostics AI services. |
| upload_time | 2025-03-21 20:46:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.11 |
| license | MIT License Copyright (c) [2025] [Aignostics GmbH (support@aignostics.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
act
aignostics
codecov
copier
cyclonedx
detect-secrets
devcontainer
docker
git-cliff
jupyter
marimo
mypy
nox
oe-python-template
pip-audit
pip-licenses
pre-commit
pydantic
pypi
pytest
python
readthedocs
ruff
sonarcloud
sonarqube
sphinx
streamlit
typer
uv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[//]: # (README.md generated from docs/partials/README_*.md)
# 🔬 Aignostics Python SDK
[
](https://github.com/aignostics/python-sdk/blob/main/LICENSE)
[](https://github.com/aignostics/python-sdk/blob/main/noxfile.py)
[](https://github.com/aignostics/python-sdk/actions/workflows/test-and-report.yml)
[](https://aignostics.readthedocs.io/en/latest/)
[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)
[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)
[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)
[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)
[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)
[](https://github.com/aignostics/python-sdk/security/code-scanning)
[](https://github.com/aignostics/python-sdk/security/dependabot)
[](https://github.com/aignostics/python-sdk/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)
[](https://codecov.io/gh/aignostics/python-sdk)
[](https://github.com/aignostics/python-sdk/blob/main/noxfile.py)
[](https://github.com/aignostics/python-sdk/blob/main/noxfile.py)
[](https://github.com/aignostics/python-sdk/releases)
[](https://github.com/aignostics/python-sdk/commits/main/)
[](https://pypi.python.org/pypi/aignostics)
[](https://pypi.python.org/pypi/aignostics)
[](https://hub.docker.com/r/helmuthva/aignostics-python-sdk/tags)
[](https://hub.docker.com/r/helmuthva/aignostics-python-sdk/)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/aignostics/python-sdk)
[](https://github.com/codespaces/new/aignostics/python-sdk)
<!---
[](https://github.com/aignostics/python-sdk/pkgs/container/python-sdk)
[](https://github.com/aignostics/python-sdk/pkgs/container/python-sdk)
-->
> [!TIP]
> 📚 [Online documentation](https://aignostics.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://aignostics.readthedocs.io/_/downloads/en/latest/pdf/)
> [!NOTE]
> 🧠This project was scaffolded using the template [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) with [copier](https://copier.readthedocs.io/).
---
Python SDK providing access to Aignostics AI services.
### Scaffolding
This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:
1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).
### Development Infrastructure
Projects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
1. Linting with [Ruff](https://github.com/astral-sh/ruff)
2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
10. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
11. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
16. Documentation published to [Read The Docs](https://readthedocs.org/)
17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
18. Python package published to [PyPI](https://pypi.org/)
19. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
21. Settings for use with [VSCode](https://code.visualstudio.com/)
22. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
### Application Features
Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning demo application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and practices already in place:
1. Service architecture suitable for use as shared library
2. Validation with [pydantic](https://docs.pydantic.dev/)
3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
4. Versioned Web API with [FastAPI](https://fastapi.tiangolo.com/)
5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
6. Simple Web UI with [Streamlit](https://streamlit.io/)
7. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
8. Documentation including badges, setup instructions, contribution guide and security policy
Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
## Generate a new project
This template is designed to be used with the [copier](https://copier.readthedocs.io/en/stable/) project generator. It allows you to create a new project based on this template and customize it according to your needs.
To generate a new project, follow these steps:
**Step 1**: Install uv package manager and copier. Copy the following code into your terminal and execute it.
```shell
if [[ "$OSTYPE" == "darwin"* ]]; then # Install dependencies for macOS X
if ! command -v brew &> /dev/null; then ## Install Homebrew if not present
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
fi
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install dependencies for Linux
sudo apt-get update -y && sudo apt-get install curl -y # Install curl
fi
if ! command -v uvx &> /dev/null; then # Install uv package manager if not present
curl -LsSf https://astral.sh/uv/install.sh | sh
source $HOME/.local/bin/env
fi
uv tool install copier # Install copier as global tool
```
**Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.
**Step 3**: Generate the project. Copy
```shell
# ensure to stand in a git repository before executing the next command
copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
```
**Step 4**: Perform initial commit and push. Copy the following code into your terminal and execute it.
```shell
git add .
git commit -m "chore: Initial commit"
git push
```
Visit your GitHub repository and check the Actions tab. The CI workflow should already be running! The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository.
**Step 5**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up
external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, and Streamlit Community Cloud.
**Step 6**: Release the first versions
```shell
./n bump
```
Notes:
1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
## Overview
Adding Aignostics Python SDK to your project as a dependency is easy. See below for usage examples.
```shell
uv add aignostics # add dependency to your project
```
If you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:
```shell
pip install aignostics # add dependency to your project
```
Executing the command line interface (CLI) in an isolated Python environment is just as easy:
```shell
uvx aignostics hello-world # prints "Hello, world! [..]"
uvx aignostics serve # serves web API
uvx aignostics serve --port=4711 # serves web API on port 4711
```
Notes:
1. The API is versioned, mounted at `/api/v1` resp. `/api/v2`
2. While serving the web API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.
3. Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
The CLI provides extensive help:
```shell
uvx aignostics --help # all CLI commands
uvx aignostics hello-world --help # help for specific command
uvx aignostics echo --help
uvx aignostics openapi --help
uvx aignostics serve --help
```
## Operational Excellence
This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
1. Various examples demonstrating usage:
a. [Simple Python script](https://github.com/aignostics/python-sdk/blob/main/examples/script.py)
b. [Streamlit web application](https://aignostics.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
c. [Jupyter](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.py) notebook
2. [Complete reference documentation](https://aignostics.readthedocs.io/en/latest/reference.html) on Read the Docs
3. [Transparent test coverage](https://app.codecov.io/gh/aignostics/python-sdk) including unit and E2E tests (reported on Codecov)
4. Matrix tested with [multiple python versions](https://github.com/aignostics/python-sdk/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
5. Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
6. Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate) and [Dependabot](https://github.com/aignostics/python-sdk/security/dependabot))
7. [A-grade code quality](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk) in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)
8. Additional code security checks using [CodeQL](https://github.com/aignostics/python-sdk/security/code-scanning)
9. [Security Policy](SECURITY.md)
10. [License](LICENSE) compliant with the Open Source Initiative (OSI)
11. 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/aignostics-python-sdk/tags)
12. Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
## Usage Examples
The following examples run from source - clone this repository using
`git clone git@github.com:aignostics/python-sdk.git`.
### Minimal Python Script:
```python
"""Example script demonstrating the usage of the service provided by Aignostics Python SDK."""
from dotenv import load_dotenv
from rich.console import Console
from aignostics import Service
console = Console()
load_dotenv()
message = Service.get_hello_world()
console.print(f"[blue]{message}[/blue]")
```
[Show script code](https://github.com/aignostics/python-sdk/blob/main/examples/script.py) - [Read the reference documentation](https://aignostics.readthedocs.io/en/latest/reference.html)
### Streamlit App
Serve the functionality provided by Aignostics Python SDK in the web by easily integrating the service into a Streamlit application.
[Try it out!](https://aignostics.streamlit.app) - [Show the code](https://github.com/aignostics/python-sdk/blob/main/examples/streamlit.py)
... or serve the app locally
```shell
uv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml
uv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser
```
## Notebooks
### Jupyter
[Show the Jupyter code](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.ipynb)
... or run within VSCode
```shell
uv sync --all-extras # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
```
Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
Click on `examples/notebook.ipynb` in VSCode and run it.
### Marimo
[Show the marimo code](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.py)
Execute the notebook as a WASM based web app
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser
```
or edit interactively in your browser
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser
```
... or edit interactively within VSCode
Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
## Command Line Interface (CLI)
### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
Show available commands:
```shell
uvx aignostics --help
```
Execute commands:
```shell
uvx aignostics hello-world
uvx aignostics echo --help
uvx aignostics echo "Lorem"
uvx aignostics echo "Lorem" --json
uvx aignostics openapi
uvx aignostics openapi --output-format=json
uvx aignostics serve
```
### Environment
The service loads environment variables including support for .env files.
```shell
cp .env.example .env # copy example file
echo "THE_VAR=MY_VALUE" > .env # overwrite with your values
```
Now run the usage examples again.
### Run with Docker
You can as well run the CLI within Docker.
```shell
docker run helmuthva/aignostics-python-sdk --help
docker run helmuthva/aignostics-python-sdk hello-world
docker run helmuthva/aignostics-python-sdk echo --help
docker run helmuthva/aignostics-python-sdk echo "Lorem"
docker run helmuthva/aignostics-python-sdk echo "Lorem" --json
docker run helmuthva/aignostics-python-sdk openapi
docker run helmuthva/aignostics-python-sdk openapi --output-format=json
docker run helmuthva/aignostics-python-sdk serve
```
Execute command:
```shell
docker run --env THE_VAR=MY_VALUE helmuthva/aignostics-python-sdk echo "Lorem Ipsum"
```
Or use docker compose
The .env is passed through from the host to the Docker container.
```shell
docker compose run aignostics --help
docker compose run aignostics hello-world
docker compose run aignostics echo --help
docker compose run aignostics echo "Lorem"
docker compose run aignostics echo "Lorem" --json
docker compose run aignostics openapi
docker compose run aignostics openapi --output-format=json
docker compose up
curl http://127.0.0.1:8000/api/v1/hello-world
curl http://127.0.0.1:8000/api/v1/docs
curl http://127.0.0.1:8000/api/v2/hello-world
curl http://127.0.0.1:8000/api/v2/docs
```
## Extra: Lorem Ipsum
Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.
## Further Reading
* Check out the [reference](https://aignostics.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.
* Our [release notes](https://aignostics.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
* In case you want to help us improve 🔬 Aignostics Python SDK: The [contribution guidelines](https://aignostics.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
## Star History
<a href="https://star-history.com/#aignostics/python-sdk">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=aignostics/python-sdk&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=aignostics/python-sdk&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=aignostics/python-sdk&type=Date" />
</picture>
</a>
Raw data
{
"_id": null,
"home_page": null,
"name": "aignostics",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "act, aignostics, codecov, copier, cyclonedx, detect-secrets, devcontainer, docker, git-cliff, jupyter, marimo, mypy, nox, oe-python-template, pip-audit, pip-licenses, pre-commit, pydantic, pypi, pytest, python, readthedocs, ruff, sonarcloud, sonarqube, sphinx, streamlit, typer, uv",
"author": null,
"author_email": "Helmut Hoffer von Ankershoffen <helmut@aignostics.com>",
"download_url": "https://files.pythonhosted.org/packages/34/e9/20ee71bdc0fd3e1cf3ae8649fde625d3023d75c174c377eeedaae8865367/aignostics-0.0.5.tar.gz",
"platform": null,
"description": "\n[//]: # (README.md generated from docs/partials/README_*.md)\n\n# \ud83d\udd2c Aignostics Python SDK\n\n[\n](https://github.com/aignostics/python-sdk/blob/main/LICENSE)\n[](https://github.com/aignostics/python-sdk/blob/main/noxfile.py)\n[](https://github.com/aignostics/python-sdk/actions/workflows/test-and-report.yml)\n[](https://aignostics.readthedocs.io/en/latest/)\n[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)\n[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)\n[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)\n[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)\n[](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk)\n[](https://github.com/aignostics/python-sdk/security/code-scanning)\n[](https://github.com/aignostics/python-sdk/security/dependabot)\n[](https://github.com/aignostics/python-sdk/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)\n[](https://codecov.io/gh/aignostics/python-sdk)\n[](https://github.com/aignostics/python-sdk/blob/main/noxfile.py)\n[](https://github.com/aignostics/python-sdk/blob/main/noxfile.py)\n[](https://github.com/aignostics/python-sdk/releases)\n[](https://github.com/aignostics/python-sdk/commits/main/)\n[](https://pypi.python.org/pypi/aignostics)\n[](https://pypi.python.org/pypi/aignostics)\n[](https://hub.docker.com/r/helmuthva/aignostics-python-sdk/tags)\n[](https://hub.docker.com/r/helmuthva/aignostics-python-sdk/)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)\n[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/aignostics/python-sdk)\n[](https://github.com/codespaces/new/aignostics/python-sdk)\n\n<!---\n[](https://github.com/aignostics/python-sdk/pkgs/container/python-sdk)\n[](https://github.com/aignostics/python-sdk/pkgs/container/python-sdk)\n-->\n\n> [!TIP]\n> \ud83d\udcda [Online documentation](https://aignostics.readthedocs.io/en/latest/) - \ud83d\udcd6 [PDF Manual](https://aignostics.readthedocs.io/_/downloads/en/latest/pdf/)\n\n> [!NOTE]\n> \ud83e\udde0 This project was scaffolded using the template [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) with [copier](https://copier.readthedocs.io/).\n\n---\n\n\nPython SDK providing access to Aignostics AI services.\n\n### Scaffolding\n\nThis [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:\n\n1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.\n2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).\n\n### Development Infrastructure\n\nProjects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:\n\n1. Linting with [Ruff](https://github.com/astral-sh/ruff)\n2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)\n3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)\n4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution\n5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)\n6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact\n7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)\n8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)\n9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)\n10. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)\n11. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks\n12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact\n13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)\n14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)\n15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export\n16. Documentation published to [Read The Docs](https://readthedocs.org/)\n17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)\n18. Python package published to [PyPI](https://pypi.org/)\n19. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)\n20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)\n21. Settings for use with [VSCode](https://code.visualstudio.com/)\n22. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)\n\n### Application Features\n\nBeyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning demo application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and practices already in place:\n\n1. Service architecture suitable for use as shared library\n2. Validation with [pydantic](https://docs.pydantic.dev/)\n3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)\n4. Versioned Web API with [FastAPI](https://fastapi.tiangolo.com/)\n5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)\n6. Simple Web UI with [Streamlit](https://streamlit.io/)\n7. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)\n8. Documentation including badges, setup instructions, contribution guide and security policy\n\nExplore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.\n\n## Generate a new project\n\nThis template is designed to be used with the [copier](https://copier.readthedocs.io/en/stable/) project generator. It allows you to create a new project based on this template and customize it according to your needs.\nTo generate a new project, follow these steps:\n\n**Step 1**: Install uv package manager and copier. Copy the following code into your terminal and execute it.\n```shell\nif [[ \"$OSTYPE\" == \"darwin\"* ]]; then # Install dependencies for macOS X\n if ! command -v brew &> /dev/null; then ## Install Homebrew if not present\n /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n fi\nelif [[ \"$OSTYPE\" == \"linux-gnu\"* ]]; then # Install dependencies for Linux\n sudo apt-get update -y && sudo apt-get install curl -y # Install curl\nfi\nif ! command -v uvx &> /dev/null; then # Install uv package manager if not present\n curl -LsSf https://astral.sh/uv/install.sh | sh\n source $HOME/.local/bin/env\nfi\nuv tool install copier # Install copier as global tool\n```\n\n**Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.\n\n**Step 3**: Generate the project. Copy\n```shell\n# ensure to stand in a git repository before executing the next command\ncopier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .\n```\n\n**Step 4**: Perform initial commit and push. Copy the following code into your terminal and execute it.\n```shell\ngit add .\ngit commit -m \"chore: Initial commit\"\ngit push\n```\n\nVisit your GitHub repository and check the Actions tab. The CI workflow should already be running! The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository.\n\n**Step 5**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up\nexternal services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, and Streamlit Community Cloud.\n\n**Step 6**: Release the first versions\n```shell\n./n bump\n```\nNotes:\n1. You can remove the above sections - from \"Scaffolding\" to this notes - post having successfully generated your project.\n2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.\n Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.\n\n\n## Overview\n\nAdding Aignostics Python SDK to your project as a dependency is easy. See below for usage examples.\n\n```shell\nuv add aignostics # add dependency to your project\n```\n\nIf you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:\n\n\n```shell\npip install aignostics # add dependency to your project\n```\n\nExecuting the command line interface (CLI) in an isolated Python environment is just as easy:\n\n```shell\nuvx aignostics hello-world # prints \"Hello, world! [..]\"\nuvx aignostics serve # serves web API\nuvx aignostics serve --port=4711 # serves web API on port 4711\n```\n\nNotes:\n1. The API is versioned, mounted at `/api/v1` resp. `/api/v2`\n2. While serving the web API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.\n3. Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)\n\n\nThe CLI provides extensive help:\n\n```shell\nuvx aignostics --help # all CLI commands\nuvx aignostics hello-world --help # help for specific command\nuvx aignostics echo --help\nuvx aignostics openapi --help\nuvx aignostics serve --help\n```\n\n\n## Operational Excellence\n\nThis project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:\n\n1. Various examples demonstrating usage:\n a. [Simple Python script](https://github.com/aignostics/python-sdk/blob/main/examples/script.py)\n b. [Streamlit web application](https://aignostics.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)\n c. [Jupyter](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.py) notebook\n2. [Complete reference documentation](https://aignostics.readthedocs.io/en/latest/reference.html) on Read the Docs\n3. [Transparent test coverage](https://app.codecov.io/gh/aignostics/python-sdk) including unit and E2E tests (reported on Codecov)\n4. Matrix tested with [multiple python versions](https://github.com/aignostics/python-sdk/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))\n5. Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))\n6. Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate) and [Dependabot](https://github.com/aignostics/python-sdk/security/dependabot))\n7. [A-grade code quality](https://sonarcloud.io/summary/new_code?id=aignostics_python-sdk) in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)\n8. Additional code security checks using [CodeQL](https://github.com/aignostics/python-sdk/security/code-scanning)\n9. [Security Policy](SECURITY.md)\n10. [License](LICENSE) compliant with the Open Source Initiative (OSI)\n11. 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/aignostics-python-sdk/tags)\n12. Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)\n\n\n## Usage Examples\n\nThe following examples run from source - clone this repository using\n`git clone git@github.com:aignostics/python-sdk.git`.\n\n### Minimal Python Script:\n\n```python\n\"\"\"Example script demonstrating the usage of the service provided by Aignostics Python SDK.\"\"\"\n\nfrom dotenv import load_dotenv\nfrom rich.console import Console\n\nfrom aignostics import Service\n\nconsole = Console()\n\nload_dotenv()\n\nmessage = Service.get_hello_world()\nconsole.print(f\"[blue]{message}[/blue]\")\n```\n\n[Show script code](https://github.com/aignostics/python-sdk/blob/main/examples/script.py) - [Read the reference documentation](https://aignostics.readthedocs.io/en/latest/reference.html)\n\n### Streamlit App\n\nServe the functionality provided by Aignostics Python SDK in the web by easily integrating the service into a Streamlit application.\n\n[Try it out!](https://aignostics.streamlit.app) - [Show the code](https://github.com/aignostics/python-sdk/blob/main/examples/streamlit.py)\n\n... or serve the app locally\n```shell\nuv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml\nuv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser\n```\n\n## Notebooks\n\n### Jupyter\n\n[Show the Jupyter code](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.ipynb)\n\n... or run within VSCode\n\n```shell\nuv sync --all-extras # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml\n```\nInstall the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)\n\nClick on `examples/notebook.ipynb` in VSCode and run it.\n\n### Marimo\n\n[Show the marimo code](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.py)\n\nExecute the notebook as a WASM based web app\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser\n```\n\nor edit interactively in your browser\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser\n```\n\n... or edit interactively within VSCode\n\nInstall the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)\n\nClick on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > \"Start in marimo editor\" (edit).\n\n## Command Line Interface (CLI)\n\n### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)\n\nShow available commands:\n\n```shell\nuvx aignostics --help\n```\n\nExecute commands:\n\n```shell\nuvx aignostics hello-world\nuvx aignostics echo --help\nuvx aignostics echo \"Lorem\"\nuvx aignostics echo \"Lorem\" --json\nuvx aignostics openapi\nuvx aignostics openapi --output-format=json\nuvx aignostics serve\n```\n\n### Environment\n\nThe service loads environment variables including support for .env files.\n\n```shell\ncp .env.example .env # copy example file\necho \"THE_VAR=MY_VALUE\" > .env # overwrite with your values\n```\n\nNow run the usage examples again.\n\n### Run with Docker\n\nYou can as well run the CLI within Docker.\n\n```shell\ndocker run helmuthva/aignostics-python-sdk --help\ndocker run helmuthva/aignostics-python-sdk hello-world\ndocker run helmuthva/aignostics-python-sdk echo --help\ndocker run helmuthva/aignostics-python-sdk echo \"Lorem\"\ndocker run helmuthva/aignostics-python-sdk echo \"Lorem\" --json\ndocker run helmuthva/aignostics-python-sdk openapi\ndocker run helmuthva/aignostics-python-sdk openapi --output-format=json\ndocker run helmuthva/aignostics-python-sdk serve\n```\n\nExecute command:\n\n```shell\ndocker run --env THE_VAR=MY_VALUE helmuthva/aignostics-python-sdk echo \"Lorem Ipsum\"\n```\n\nOr use docker compose\n\nThe .env is passed through from the host to the Docker container.\n\n```shell\ndocker compose run aignostics --help\ndocker compose run aignostics hello-world\ndocker compose run aignostics echo --help\ndocker compose run aignostics echo \"Lorem\"\ndocker compose run aignostics echo \"Lorem\" --json\ndocker compose run aignostics openapi\ndocker compose run aignostics openapi --output-format=json\ndocker compose up\ncurl http://127.0.0.1:8000/api/v1/hello-world\ncurl http://127.0.0.1:8000/api/v1/docs\ncurl http://127.0.0.1:8000/api/v2/hello-world\ncurl http://127.0.0.1:8000/api/v2/docs\n```\n\n## Extra: Lorem Ipsum\n\nDolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.\n\n\n## Further Reading\n\n* Check out the [reference](https://aignostics.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.\n* Our [release notes](https://aignostics.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.\n* In case you want to help us improve \ud83d\udd2c Aignostics Python SDK: The [contribution guidelines](https://aignostics.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.\n\n## Star History\n\n<a href=\"https://star-history.com/#aignostics/python-sdk\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=aignostics/python-sdk&type=Date&theme=dark\" />\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=aignostics/python-sdk&type=Date\" />\n <img alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=aignostics/python-sdk&type=Date\" />\n </picture>\n</a>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2025] [Aignostics GmbH (support@aignostics.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "\ud83d\udd2c Python SDK providing access to Aignostics AI services.",
"version": "0.0.5",
"project_urls": {
"Changelog": "https://github.com/aignostics/python-sdk/releases",
"Documentation": "https://aignostics.readthedocs.io/en/latest/",
"Homepage": "https://aignostics.readthedocs.io/en/latest/",
"Issues": "https://github.com/aignostics/python-sdk/issues",
"Source": "https://github.com/aignostics/python-sdk"
},
"split_keywords": [
"act",
" aignostics",
" codecov",
" copier",
" cyclonedx",
" detect-secrets",
" devcontainer",
" docker",
" git-cliff",
" jupyter",
" marimo",
" mypy",
" nox",
" oe-python-template",
" pip-audit",
" pip-licenses",
" pre-commit",
" pydantic",
" pypi",
" pytest",
" python",
" readthedocs",
" ruff",
" sonarcloud",
" sonarqube",
" sphinx",
" streamlit",
" typer",
" uv"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4c952e8d3dc01a8df8f006b7223bffd671af46e196520880f27bc726c5896bd0",
"md5": "2b75a8a2b10d414380533ad99672d9f0",
"sha256": "beb596bf497dea96dc99304a18ed97f268c498254ed4181e29487d7121c9f78d"
},
"downloads": -1,
"filename": "aignostics-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b75a8a2b10d414380533ad99672d9f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 15338,
"upload_time": "2025-03-21T20:46:50",
"upload_time_iso_8601": "2025-03-21T20:46:50.559995Z",
"url": "https://files.pythonhosted.org/packages/4c/95/2e8d3dc01a8df8f006b7223bffd671af46e196520880f27bc726c5896bd0/aignostics-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "34e920ee71bdc0fd3e1cf3ae8649fde625d3023d75c174c377eeedaae8865367",
"md5": "ec76ffc62f820faf576b0cd540cbbec4",
"sha256": "d150a2d904b9b92ac57528061b189de25a9f0a7b6f509e48fac70372d73247a1"
},
"downloads": -1,
"filename": "aignostics-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "ec76ffc62f820faf576b0cd540cbbec4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 23785,
"upload_time": "2025-03-21T20:46:52",
"upload_time_iso_8601": "2025-03-21T20:46:52.331310Z",
"url": "https://files.pythonhosted.org/packages/34/e9/20ee71bdc0fd3e1cf3ae8649fde625d3023d75c174c377eeedaae8865367/aignostics-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-21 20:46:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aignostics",
"github_project": "python-sdk",
"github_not_found": true,
"lcname": "aignostics"
}
