Skip to main content

Jambazid/demo

Minimal working example of a packaged Python project. Key integrations include:

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 sqlflint 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sqlflint 0.0.3
File Size Uploaded Provenance Actions
sqlflint-0.0.3.tar.gz 6.0 kB Without provenance Details for sqlflint-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sqlflint 0.0.3
File Interpreter ABI Platform Actions
sqlflint-0.0.3-py3-none-any.whl Python 3 none any Details for sqlflint-0.0.3-py3-none-any.whl

Total release size: 12.4 kB

Release files / sqlflint-0.0.3.tar.gz

Download URL sqlflint-0.0.3.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
80847cd3471d5ab66d1c586912fff97f7b77f9da32723ecb10ef8e5e60c980c4
BLAKE2b-256 checksum
How to use checksums
89ca4db64d6df09d360ab2710d05896d7c8bc2e9e93ededa230cd9a2f3f417f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pengwin","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / sqlflint-0.0.3-py3-none-any.whl

Download URL sqlflint-0.0.3-py3-none-any.whl
Size 6.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a2f5592b5a13b474eae4f4a9bd5fc24fbf3dc36b5c653be2c142d1f7a203dc4b
BLAKE2b-256 checksum
How to use checksums
9d110bdd5ff9a5b2ec5ba565de0b02d92f2ed326e107003ae79104f3fca38051
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pengwin","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for sqlflint 0.0.3

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.

Release history Release notifications | RSS feed

This release

0.0.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page