Jambazid/demo
Minimal working example of a packaged Python project. Key integrations include:
- Build System (uv).
- Test Framework (PyTest).
- Documentation as Code (zensical).
- CI/CD (GitHub Actions).
Contents
Structure
Documentation is generated from Python docstrings and takes a structure mirroring that of the source code (API documentation).
Initial focus could be on high-level (public) APIs intended for direct use by end-users.
Developers can thus grow the documentation organically within a single task-based workflow. As soon as a new feature/function is added - the developer need only include a docstring in their commit and it will reflect in the hosted page.
Markdown and ReST Support
The zensical framework renders Markdown in docstrings to HTML:
- Lists
- Are
- Supported
As are code blocks:
# Example invocation
result: Type = function(param="value", *variadic_args, **variadic_kwargs)
Data Models
The pydantic framework has quickly become the leading
data validation library for Python.
It's not a stretch to say that there's a whole ecosystem being built around it with everything from web frameworks to data science toolkits using it as the base for their data models.
From a documentation perspective, if you can describe your data source as a pydantic derived
data model and then group them accordingly
such links could be fronted as data schemas. Standard representations such as "JSON Schema" can
be generated directly from pydantic models.
This also has advantages for testing.
Metadata
Release files for jambazid-uv-demo 0.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| jambazid_uv_demo-0.4.2.tar.gz | 6.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jambazid_uv_demo-0.4.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.5 kB
Release files / jambazid_uv_demo-0.4.2.tar.gz
| Download URL | jambazid_uv_demo-0.4.2.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7af182c2d29646903cb721963be325be32ceb75ae3b2076ef683f35f4c42d161
|
|
BLAKE2b-256 checksum How to use checksums |
37360e3b2cbde39d5a075cb2b7836f13286d57c8a7b48049f8c01b904b59f122
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / jambazid_uv_demo-0.4.2-py3-none-any.whl
| Download URL | jambazid_uv_demo-0.4.2-py3-none-any.whl |
|---|---|
| Size | 6.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
025bf5449fa846b2e2eff6ebd7fd799c3de57b028a1aab621711be9a2fae8ea4
|
|
BLAKE2b-256 checksum How to use checksums |
1bae281f4b1a11d44ef450125b27c8c95feaec5d58ee8a96b9456a49f82b3429
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for jambazid-uv-demo 0.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
