TF2MD
A readme generator for terraform code.
About
Have you ever wanted to generate markdown documentation based on variables.tf or outputs.tf files?
This tool aims to solve that.
Usage
Install the program
pip install tf2md
Run the program <Where terraform/outputs.tf is the path to my file>:
tf2md gen-docs terraform/outputs.tf
Note: This does not work on tf files that have a mix of outputs and variables.
See the ./examples dir for examples of generated code.
Dev Notes
Here are things I want to do:
-
Tests
-
I am not happy with the
create_variables_filefunction, I want to clean it up, but right now I just want to use the tool. -
I want to be able to add an output arg to the cli so the created files do not just get dummped in the
./ -
Verbose logging and options are required
1 maintainer
Metadata
1 maintainer
Release files for tf2md 1.0.3
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 | |
|---|---|---|---|---|
| tf2md-1.0.3.tar.gz | 5.2 kB | Without provenance | Details |
Release files / tf2md-1.0.3.tar.gz
| Download URL | tf2md-1.0.3.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d363278b437ce2a3f1589c6cd5c7c88a89ba0be289c626837707b3748fe76c94
|
|
BLAKE2b-256 checksum How to use checksums |
721ce20e5db029881c82a7d644c5744d771520fefb0dafe5f16af94bc8507613
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Security for tf2md 1.0.3
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.
