Skip to content
This repository was archived by the owner on Feb 20, 2026. It is now read-only.

Commit cca3345

Browse files
committed
docs: README improvements
1 parent 87c1658 commit cca3345

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
11
# doppler-env
22

3-
Inject Doppler secrets as environment variables into your Python application during local development. Provides debugging support in PyCharm, Visual Studio Code, and other IDEs and editors.
4-
5-
Inspired by [patch-env](https://github.com/caricalabs/patch-env).
6-
7-
> NOTE: This package should be used during local development only. It is not suitable, recommended, or supported for production usage.
3+
Inject Doppler secrets as environment variables into your Python application during local development with built-in debugging support for PyCharm and Visual Studio Code.
84

95
## How it works
106

11-
Debugging in IDE's such as PyCharm and Visual Studio Code do not allow the Doppler CLI to be used as the process runner for Python as they use their own Python debugger entrypoint. This often forces developers to resort to insecure practices such saving Doppler secrets to an `.env` file during development, the very problem Doppler was created to prevent.
7+
Debugging support in PyCharm and Visual Studio Code is provided by a vendor-specific Python entry-point which prevents the Doppler CLI from being used to directly inject secrets.
8+
9+
This limitation may force developers to use insecure practices such as saving secrets to an unencrypted `.env` file—the issue Doppler was created to prevent.
1210

13-
The **doppler-env** package provides a solution in the form of a [site hook that is run at Python startup](https://docs.python.org/3/library/site.html).
11+
Simply set the `DOPPLER_ENV` environment variable, and the `doppler-env` package will fetch your secrets using the Doppler CLI, injecting them as environment variables before executing your Python code.
1412

15-
If the `DOPPLER_ENV` environment variable is set, the package will call out to the Doppler CLI to fetch secrets for the project and inject them as environment variables into the process spwawned by the commmand line or IDE with your secrets never touching the file system.
13+
All this while ensuring secrets never touch the file system.
1614

1715
## Requirements
1816

19-
Ensure the [Doppler CLI](https://docs.doppler.com/docs/enclave-installation) is installed and you have [created a project in Doppler](https://docs.doppler.com/docs/enclave-project-setup).
17+
Ensure you have installed the [Doppler CLI](https://docs.doppler.com/docs/enclave-installation) and [created a project in the Doppler dashboard](https://docs.doppler.com/docs/enclave-project-setup).
2018

21-
Then authenticate the Doppler CLI so it can retrieve secrets from your workplace:
19+
Then in a local terminal, authorize the Doppler CLI to retrieve secrets from your workplace:
2220

2321
```sh
2422
doppler login
2523
```
2624

2725
## Getting started
2826

29-
1. If you haven't already, open a new terminal window, change into the repository folder, then configure the Doppler CLI by selecting the project and config for development:
27+
1. If you haven't already, open a new terminal window, change into the repository folder, then configure the Doppler CLI by selecting the project and config to supply secrets for:
3028

3129
```sh
3230
doppler setup
@@ -38,14 +36,26 @@ doppler setup
3836
pip install doppler-env
3937
```
4038

41-
3. On the command line or in your editor, set the environment variable `DOPPLER_ENV` to trigger injecting secrets as environment variables:
39+
3. Define the `DOPPLER_ENV` environment variable in your IDE, editor, or terminal:
4240

4341
```sh
4442
export DOPPLER_ENV=1
4543
```
4644

47-
4. Run or debug your application as per normal:
45+
4. Run or debug your application in your IDE, editor, or terminal:
4846

4947
```sh
5048
python src/app.py
5149
```
50+
51+
## Acknowledgements
52+
53+
This approach to injecting environment variables was inspired by [patch-env](https://github.com/caricalabs/patch-env) and customized to be Doppler specific.
54+
55+
## Issues
56+
57+
For any bug reports, issues, or enhancements, please [create a repository issue](https://github.com/DopplerHQ/python-doppler-env/issues/new).
58+
59+
## Support
60+
61+
Paid subscribers can use in-product support while those on Doppler's free community plan can receive help in our [Community forum](https://community.doppler.com/).

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ def long_description():
2121

2222
setup(
2323
name='doppler_env',
24-
version='0.1.1',
24+
version='0.2.0',
2525
python_requires='>=3.8',
26-
description='Automatically inject Doppler secrets as environment variables for use during local development',
26+
description='Inject Doppler secrets as environment variables into your Python application during local development with built-in debugging support for PyCharm and Visual Studio Code',
2727
long_description=long_description(),
2828
long_description_content_type='text/markdown',
2929
url='https://github.com/dopplerhq/python-doppler-env',

0 commit comments

Comments
 (0)