mkdocs-sqlalchemy-plugin
MkDocs plugin to generate docs from SQLAlchemy models.
Features
- Automatic Documentation: Generates tables documenting your SQLAlchemy models.
- Customizable: Configure which fields to show, table styling, and more.
- Filtering: Include or exclude specific tables.
- SQL DDL: Optionally display the SQL
CREATE TABLEstatements. - Schema Support: Group tables by schema.
Installation
Install the plugin using pip:
pip install mkdocs-sqlalchemy-plugin
Quick Start
-
Configure
mkdocs.yml:Add the plugin to your
mkdocs.ymlconfiguration file. You must specify thebase_classwhich is the import path to your SQLAlchemyDeclarativeBase.plugins: - sqlalchemy: base_class: "my_app.models.Base" app_path: "src"
-
Add to Markdown:
In your markdown files, use the
sqlalchemytag where you want the documentation to appear.{% sqlalchemy %} -
Build Docs:
Run
mkdocs serveto see your documentation.
Configuration
The plugin offers extensive configuration options to tailor the output to your needs. See the Configuration Options page for a full reference.
Usage
The {% sqlalchemy %} tag is powerful and supports local overrides. See the Tag Usage page for details.
Metadata
Release files for mkdocs-sqlalchemy-plugin 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs_sqlalchemy_plugin-0.1.0.tar.gz | 11.9 kB | Without provenance | Details for mkdocs_sqlalchemy_plugin-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_sqlalchemy_plugin-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_sqlalchemy_plugin-0.1.0-py3-none-any.whl |
Total release size: 26.3 kB
Release files / mkdocs_sqlalchemy_plugin-0.1.0.tar.gz
| Download URL | mkdocs_sqlalchemy_plugin-0.1.0.tar.gz |
|---|---|
| Size | 11.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
77fbe0ca8d3bfe9cc5ed201f2d2d3cfe9ce991d241f278c3b02408da7e59844a
|
|
BLAKE2b-256 checksum How to use checksums |
a7db8e28516d948712cb0910b6b9fb4be033f929cb60c6b8012f9600e8477e95
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.11 {"installer":{"name":"uv","version":"0.9.11"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mkdocs_sqlalchemy_plugin-0.1.0-py3-none-any.whl
| Download URL | mkdocs_sqlalchemy_plugin-0.1.0-py3-none-any.whl |
|---|---|
| Size | 14.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
818471afccfda46282a1ea46a149b173ccbfe33685b591b9a41cd929fdf5a3bc
|
|
BLAKE2b-256 checksum How to use checksums |
9abcb0d69d72fc4da3f7ab3ed4d0dfd5e66a4a5b723d4f0261f52b7ed143f847
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.11 {"installer":{"name":"uv","version":"0.9.11"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for mkdocs-sqlalchemy-plugin 0.1.0
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.