Skip to content

Commit 3860c6b

Browse files
committed
version bump to 0.0.2
1 parent 971fa37 commit 3860c6b

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[![PyPI version](https://badge.fury.io/py/clean-dotenv.svg)](https://badge.fury.io/py/clean-dotenv)
2+
3+
clean-dotenv
4+
======================
5+
6+
Automatically creates an .env.example which creates the same keys as your .env file, but without the values
7+
8+
9+
## Installation
10+
11+
```bash
12+
pip install clean-dotenv
13+
```
14+
15+
16+
## Console scripts
17+
18+
Consult `clean-dotenv --help` for the full set of options.
19+
20+
Common options:
21+
22+
- `--root path`: Defines the root path in which to look for .env files
23+
24+
## As a pre-commit hook
25+
26+
See [pre-commit](https://github.com/pre-commit/pre-commit) for instructions
27+
28+
Sample `.pre-commit-config.yaml`
29+
30+
```yaml
31+
- repo: https://github.com/hija/clean-dotenv
32+
rev: v0.0.2
33+
hooks:
34+
- id: clean-dotenv
35+
```
36+
37+
## What does it do?
38+
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.
39+
40+
As a result, you always have an up-to-date `.env.example` file. This shall help to reduce forgetting updating the `.env.example` files!

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[metadata]
22
name = clean_dotenv
3-
version = 0.0.1
3+
version = 0.0.2
44
description = Automatically creates an .env.example which creates the same keys as your .env file, but without the values
55
long_description = file: README.md
66
long_description_content_type = text/markdown

0 commit comments

Comments
 (0)