Skip to main content

A minimal Python project template built with Poetry.

Project description

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

Advanced tools

The pdoc framework is arguably the simplest auto-documentation tool for Python.

Below are some more advanced tools that are popular with large open-source projects:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jambazid-0.0.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

jambazid-0.0.0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file jambazid-0.0.0.tar.gz.

File metadata

  • Download URL: jambazid-0.0.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for jambazid-0.0.0.tar.gz
Algorithm Hash digest
SHA256 61af54d4808da5ba8b78532dfb453b68d68fabb35593c5a463ccf697b094bc4d
MD5 42b3338ddd0440d7e68a410aa294c080
BLAKE2b-256 a70ee46e362133670a15dfc43b26cd8eb411451817112de4991ebd5692b9847e

See more details on using hashes here.

File details

Details for the file jambazid-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: jambazid-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for jambazid-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a33f261e396c0cf5438185a3f9abb18244bb46c3040dcd4f6c1ff8617ac7871e
MD5 ec9ab712802ab2f0b8d179d8024d5762
BLAKE2b-256 78e5e99a3108f09d2033cb7cf4b97dec65c879497a58b0d6cdce61aa1d194656

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page