aignostics 0.0.2__tar.gz → 0.0.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: aignostics
3
- Version: 0.0.2
3
+ Version: 0.0.3
4
4
  Summary: 🔬 Python SDK providing access to Aignostics AI services.
5
5
  Project-URL: Homepage, https://aignostics.readthedocs.io/en/latest/
6
6
  Project-URL: Documentation, https://aignostics.readthedocs.io/en/latest/
@@ -106,36 +106,44 @@ Description-Content-Type: text/markdown
106
106
 
107
107
  Python SDK providing access to Aignostics AI services.
108
108
 
109
- This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate a Python package with fully functioning build and test automation.
110
- 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.
111
-
112
- Features:
113
- 1. Package management with [uv](https://github.com/astral-sh/uv)
114
- 2. Code formatting with [Ruff](https://github.com/astral-sh/ruff)
115
- 3. Linting with [Ruff](https://github.com/astral-sh/ruff)
116
- 4. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
117
- 5. 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)
118
- 6. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
119
- 7. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
120
- 8. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
121
- 9. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
122
- 10. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
123
- 11. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
124
- 12. 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)
125
- 13. 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
126
- 14. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
127
- 15. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
128
- 16. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
129
- 17. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
130
- 18. Documentation published to [Read The Docs](https://readthedocs.org/)
131
- 19. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
132
- 20. Python package published to [PyPI](https://pypi.org/)
133
- 21. 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)
134
- 22. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
135
- 23. Settings for use with [VSCode](https://code.visualstudio.com/)
136
- 24. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
137
-
138
- The generated project includes code, documentation and configuration of a fully functioning demo-application and service, which can be used as a starting point for your own project.
109
+ ### Scaffolding
110
+
111
+ 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:
112
+
113
+ 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.
114
+ 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).
115
+
116
+ ### Development Infrastructure
117
+
118
+ 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:
119
+
120
+ 1. Linting with [Ruff](https://github.com/astral-sh/ruff)
121
+ 2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
122
+ 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)
123
+ 4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
124
+ 5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
125
+ 6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
126
+ 7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
127
+ 8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
128
+ 9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
129
+ 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)
130
+ 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
131
+ 12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
132
+ 13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
133
+ 14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
134
+ 15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
135
+ 16. Documentation published to [Read The Docs](https://readthedocs.org/)
136
+ 17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
137
+ 18. Python package published to [PyPI](https://pypi.org/)
138
+ 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)
139
+ 20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
140
+ 21. Settings for use with [VSCode](https://code.visualstudio.com/)
141
+ 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)
142
+
143
+ ### Application Features
144
+
145
+ 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:
146
+
139
147
  1. Service architecture suitable for use as shared library
140
148
  2. Validation with [pydantic](https://docs.pydantic.dev/)
141
149
  3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
@@ -193,9 +201,10 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
193
201
  ./n bump
194
202
  ```
195
203
  Notes:
196
- 1. You can remove this section post having successfully generated your project.
197
- 2. The following sections refer to the dummy application and service provided by this template.
198
- Use them as inspiration and adapt them to your own project.
204
+ 1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
205
+ 2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
206
+ Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
207
+
199
208
 
200
209
  ## Overview
201
210
 
@@ -45,36 +45,44 @@
45
45
 
46
46
  Python SDK providing access to Aignostics AI services.
47
47
 
48
- This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate a Python package with fully functioning build and test automation.
49
- 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.
50
-
51
- Features:
52
- 1. Package management with [uv](https://github.com/astral-sh/uv)
53
- 2. Code formatting with [Ruff](https://github.com/astral-sh/ruff)
54
- 3. Linting with [Ruff](https://github.com/astral-sh/ruff)
55
- 4. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
56
- 5. 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)
57
- 6. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
58
- 7. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
59
- 8. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
60
- 9. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
61
- 10. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
62
- 11. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
63
- 12. 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)
64
- 13. 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
65
- 14. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
66
- 15. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
67
- 16. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
68
- 17. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
69
- 18. Documentation published to [Read The Docs](https://readthedocs.org/)
70
- 19. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
71
- 20. Python package published to [PyPI](https://pypi.org/)
72
- 21. 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)
73
- 22. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
74
- 23. Settings for use with [VSCode](https://code.visualstudio.com/)
75
- 24. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
76
-
77
- The generated project includes code, documentation and configuration of a fully functioning demo-application and service, which can be used as a starting point for your own project.
48
+ ### Scaffolding
49
+
50
+ 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:
51
+
52
+ 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.
53
+ 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).
54
+
55
+ ### Development Infrastructure
56
+
57
+ 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:
58
+
59
+ 1. Linting with [Ruff](https://github.com/astral-sh/ruff)
60
+ 2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
61
+ 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)
62
+ 4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
63
+ 5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
64
+ 6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
65
+ 7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
66
+ 8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
67
+ 9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
68
+ 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)
69
+ 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
70
+ 12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
71
+ 13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
72
+ 14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
73
+ 15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
74
+ 16. Documentation published to [Read The Docs](https://readthedocs.org/)
75
+ 17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
76
+ 18. Python package published to [PyPI](https://pypi.org/)
77
+ 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)
78
+ 20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
79
+ 21. Settings for use with [VSCode](https://code.visualstudio.com/)
80
+ 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)
81
+
82
+ ### Application Features
83
+
84
+ 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:
85
+
78
86
  1. Service architecture suitable for use as shared library
79
87
  2. Validation with [pydantic](https://docs.pydantic.dev/)
80
88
  3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
@@ -132,9 +140,10 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
132
140
  ./n bump
133
141
  ```
134
142
  Notes:
135
- 1. You can remove this section post having successfully generated your project.
136
- 2. The following sections refer to the dummy application and service provided by this template.
137
- Use them as inspiration and adapt them to your own project.
143
+ 1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
144
+ 2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
145
+ Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
146
+
138
147
 
139
148
  ## Overview
140
149
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "aignostics"
3
- version = "0.0.2"
3
+ version = "0.0.3"
4
4
  description = "🔬 Python SDK providing access to Aignostics AI services."
5
5
  readme = "README.md"
6
6
  authors = [
@@ -248,7 +248,7 @@ source = ["src/"]
248
248
 
249
249
 
250
250
  [tool.bumpversion]
251
- current_version = "0.0.2"
251
+ current_version = "0.0.3"
252
252
  parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
253
253
  serialize = ["{major}.{minor}.{patch}"]
254
254
  search = "{current_version}"
File without changes
File without changes