auto-example-env
A Python utility to generate example.env from your .env file for documentation purposes.
Installation
pip install auto-example-env
Usage
# Generate example.env from .env in current directory
auto-example-env
# Specify custom input/output files
auto-example-env --input .env --output example.env
Features
- Converts
export KEY=VALUEtoexport KEY= - Handles multiline quoted values (e.g., PEM certificates) by adding a comment above
- Skips keys marked with
# ignore(case insensitive) - Preserves comments and empty lines
- Always overwrites
example.env
Example
Given .env:
export API_KEY=secret
# ignore export SECRET=hidden
export CERT="-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----"
Generates example.env:
export API_KEY=
# Multiline value
export CERT=
1 maintainer
Metadata
1 maintainer
Release files for auto-example-env 1.0.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 | |
|---|---|---|---|---|
| auto_example_env-1.0.0.tar.gz | 4.8 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| auto_example_env-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.6 kB
Release files / auto_example_env-1.0.0.tar.gz
| Download URL | auto_example_env-1.0.0.tar.gz |
|---|---|
| Size | 4.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7e7d46a3c9ede7edc5910e85995555c85b8f7fdcd14658c88ec3ea9d6af0f70d
|
|
BLAKE2b-256 checksum How to use checksums |
c2a7d9f31f440d6df520a657f9d6b5d2ef75069e52774ad53cae4b76cdef0448
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 18, 2026.
Transparency logRelease files / auto_example_env-1.0.0-py3-none-any.whl
| Download URL | auto_example_env-1.0.0-py3-none-any.whl |
|---|---|
| Size | 3.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c406c9ebd5ca17957b7e74879e7ec8a62a99add2b988942311ab96827c6b9282
|
|
BLAKE2b-256 checksum How to use checksums |
d6e055be2e49b29f16bc4741d1567f394540d9b26ca0f8e90cab1b796b5b81fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 18, 2026.
Transparency logSecurity for auto-example-env 1.0.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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for auto_example_env-1.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 18, 2026.
Transparency logA 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.
