A command line tool for generating Markdown documentation and .env files from pydantic BaseSettings.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for radeklat from gravatar.com radeklat

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT)

Author: Radek Lát

Tags documentation, environment variables, generated, markdown, BaseSettings

Requires: Python >=3.6.2, <4.0.0

Classifiers

Project description

:gear::memo:   Settings DocGen   :memo::gear:

A command line tool for generating Markdown documentation and .env files from pydantic.BaseSettings.

CircleCI Codecov GitHub tag (latest SemVer) Maintenance GitHub last commit PyPI - Downloads PyPI - License PyPI - Python Version

Installation

pip install settings-doc

TODOs

  • Improve this README
    • Add usage instructions
    • Add features overview
  • Add an update flag to update existing documents between two marks

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for radeklat from gravatar.com radeklat

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT)

Author: Radek Lát

Tags documentation, environment variables, generated, markdown, BaseSettings

Requires: Python >=3.6.2, <4.0.0

Classifiers

Release history Release notifications | RSS feed

4.0.1

4.0.0

3.1.2

3.1.1

3.1.0

3.0.1

3.0.0

2.1.0

2.0.0

1.0.0

0.8.1

0.8.0

0.7.0

0.6.1

0.6.0

0.5.1

0.5.0

This version

0.4.0

0.3.0

Download files

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

Source Distribution

settings-doc-0.4.0.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

settings_doc-0.4.0-py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 3

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