Skip to main content

Codemod to load environment variables at startup. 📝

Project description

load-env-vars-at-startup

Latest Commit
Package version

To understand the motivation behind this package, you might want to read about fail fast.

What this package does is to make sure you are reading all the environment variables at startup.

Example

Consider that you have a folder with the following structure:

app/
├── __init__.py
└── main.py

Inside of main.py you have:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def index():
    name = os.environ["APP_NAME"]
    return {"message": f"Hello, {name}!"}

If you run this application, it will run without any problem, but if you forget to set the APP_NAME environment variable, you will get an error when you try to access the / endpoint.

To avoid this, you can use this package.

If you decide to use it, your folder structure will look like this:

app/
├── __init__.py
├── main.py
└── config.py

Your config.py will look like this:

from pydantic import BaseSettings

class Settings(BaseSettings):
    APP_NAME: str

settings = Settings()

And your main.py will look like this:

from fastapi import FastAPI
from app.config import settings

app = FastAPI()

@app.get("/")
def index():
    name = settings.APP_NAME
    return {"message": f"Hello, {name}!"}

Installation

You can install load-env-vars-at-startup via pip:

pip install load-env-vars-at-startup

Usage

levas DIR

Where DIR is the directory of your application.

License

This project is licensed under the terms of the MIT license.

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

load_env_vars_at_startup-0.1.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

load_env_vars_at_startup-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file load_env_vars_at_startup-0.1.0.tar.gz.

File metadata

File hashes

Hashes for load_env_vars_at_startup-0.1.0.tar.gz
Algorithm Hash digest
SHA256 487ae7ec01e726ae59bbbc480c0b372831035b44d0770717af2b8c85cec771d3
MD5 968be95a75308a3b2bc6a1749becca70
BLAKE2b-256 8e8d0367cd392a579874f5ce44886008af5b9e85654f2b050454ceace93f9246

See more details on using hashes here.

File details

Details for the file load_env_vars_at_startup-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for load_env_vars_at_startup-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4c3733819366282f2a0b651ec6e15d24a3978eee7149a43a96eda1aff3b21fd
MD5 a9232e9c5c8cb16d9edabefb6b556503
BLAKE2b-256 80bac1bdb5716e324905a34063d3be6417ead1a1a7e561ae17338f35cf803095

See more details on using hashes here.

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