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_poetry_demo-0.0.22.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

jambazid_poetry_demo-0.0.22-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file jambazid_poetry_demo-0.0.22.tar.gz.

File metadata

  • Download URL: jambazid_poetry_demo-0.0.22.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for jambazid_poetry_demo-0.0.22.tar.gz
Algorithm Hash digest
SHA256 2245f2b9ab78c76fd198a4d2d82f83754e459f5842273f88092c7ad4ab501b9d
MD5 2f3c798dc7affef99cfe08f786ae87ec
BLAKE2b-256 cd1b16c89d1f69fb85c2a9716c8740d6735188c95a0ed752a57d48a82b30b59d

See more details on using hashes here.

File details

Details for the file jambazid_poetry_demo-0.0.22-py3-none-any.whl.

File metadata

File hashes

Hashes for jambazid_poetry_demo-0.0.22-py3-none-any.whl
Algorithm Hash digest
SHA256 56694814e9aeb6434ced5aebd921b6624da61282f7bcf91107cb9e6ee99fb95c
MD5 355810c66283fa34556f1b2adfd065f1
BLAKE2b-256 e39db16e0c62a4a27019fe0375712be42b3c97890542d94439c969db3c702029

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