Skip to main content

Automatically creates an .env.example which creates the same keys as your .env file, but without the values

Project description

PyPI version

clean-dotenv

Automatically creates an .env.example which creates the same keys as your .env file, but without the values

Installation

pip install clean-dotenv

Console scripts

Consult clean-dotenv --help for the full set of options.

Common options:

  • --root path: Defines the root path in which to look for .env files

As a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml

-   repo: https://github.com/hija/clean-dotenv
    rev: v0.0.3
    hooks:
    -   id: clean-dotenv

What does it do?

The tool looks for .env files in all directories and creates a new, corresponding filename .env.example which is save to commit, since it contains all the keys from your .env file, but without its values.

As a result, you always have an up-to-date .env.example file. This shall help to reduce forgetting updating the .env.example files!

Project details


Download files

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

Source Distribution

clean_dotenv-0.0.3.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

clean_dotenv-0.0.3-py2.py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 2 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