https://github.com/hmiladhia/auto-dotenv

Automatically load .env variables if auto-dotenv is installed
https://github.com/hmiladhia/auto-dotenv

Last synced: 2 days ago
JSON representation

Automatically load .env variables if auto-dotenv is installed

• Host: GitHub
• URL: https://github.com/hmiladhia/auto-dotenv
• Owner: hmiladhia
• License: mit
• Created: 2024-03-09T13:47:14.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-09T15:01:22.000Z (8 months ago)
• Last Synced: 2024-10-12T16:08:00.284Z (about 1 month ago)
• Language: Python
• Size: 8.79 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pyauto-dotenv

![PyPI](https://img.shields.io/pypi/v/pyauto-dotenv)

![PyPI - License](https://img.shields.io/pypi/l/pyauto-dotenv)

![PyPI - Wheel](https://img.shields.io/pypi/wheel/pyauto-dotenv)

![Tests](https://github.com/hmiladhia/auto-dotenv/actions/workflows/quality.yaml/badge.svg)

`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:

```python

from dotenv import load_dotenv

load_dotenv()

```

### Installation

You can install `pyauto-dotenv` via pip:

```bash

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:

```python

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](https://github.com/hmiladhia/auto-dotenv).

### License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

### Disclaimer

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