Metadata-Version: 2.1
Name: settings-doc
Version: 0.3.0
Summary: A command line tool for generating Markdown documentation and .env files from pydantic BaseSettings.
Home-page: https://github.com/radeklat/settings-doc
License: MIT
Keywords: documentation,environment variables,generated,markdown,BaseSettings
Author: Radek Lát
Author-email: radek.lat@gmail.com
Requires-Python: >=3.6.2,<4.0.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Software Distribution
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Dist: Jinja2 (>=3.0.2,<4.0.0)
Requires-Dist: pydantic (>=1.8.2,<2.0.0)
Requires-Dist: termcolor (>=1.1.0,<2.0.0)
Requires-Dist: typer[all] (>=0.4.0,<0.5.0)
Description-Content-Type: text/markdown

<h1 align="center" style="border-bottom: none;">:gear::memo:&nbsp;&nbsp; Settings DocGen &nbsp;&nbsp;:memo::gear:</h1>
<h3 align="center">A command line tool for generating Markdown documentation and .env files from <a href="https://pydantic-docs.helpmanual.io/usage/settings">pydantic.BaseSettings</a>.</h3>

<p align="center">
    <img alt="CircleCI" src="https://img.shields.io/circleci/build/github/radeklat/settings-doc">
    <img alt="Codecov" src="https://img.shields.io/codecov/c/github/radeklat/settings-doc">
    <img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/tag/radeklat/settings-doc">
    <img alt="Maintenance" src="https://img.shields.io/maintenance/yes/2021">
    <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/radeklat/settings-doc">
    <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/settings-doc">
    <img alt="PyPI - License" src="https://img.shields.io/pypi/l/settings-doc">
    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/settings-doc">
</p>

# 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

