Skip to content

Automatically load .env variables if auto-dotenv is installed

License

Notifications You must be signed in to change notification settings

hmiladhia/auto-dotenv

Repository files navigation

pyauto-dotenv

PyPI PyPI - License PyPI - Wheel

Tests

pyauto-dotenv is a python package that simplifies the process of loading environment variables from a .env file in your project. With pyauto-dotenv, you no longer need to manually load the .env file in your code. This package automatically loads the variables from the .env file if the auto-dotenv package is installed in your environment.

pyauto-dotenv is just a wrapper around python-dotenv. In fact what it does is basically run the following code everytime you run a python file:

from dotenv import load_dotenv

load_dotenv()

Installation

You can install pyauto-dotenv via pip:

pip install pyauto-dotenv

Usage

Using pyauto-dotenv is straightforward. Once you've installed the package, that's it! If a .env file is present in your project directory, pyauto-dotenv will automatically load its contents into the environment.

You can define the following environment variable to override the default .env file: AUTO_DOTENV_PATH, AUTO_DOTENV_ENV

Example

Let's say you have a .env file with the following contents:

DB_HOST=localhost
DB_USER=admin
DB_PASS=password123

Normally, you would need to load these variables manually in your code. However, with pyauto-dotenv, you can access these variables directly from the environment:

import os

print(os.environ['DB_HOST'])  # Output: localhost
print(os.environ['DB_USER'])  # Output: admin
print(os.environ['DB_PASS'])  # Output: password123

Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Disclaimer

This package comes with no warranties or guarantees. Use it at your own risk.

About

Automatically load .env variables if auto-dotenv is installed

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages