Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the env option to dj_database_url.config #248

Open
edmorley opened this issue May 24, 2024 · 2 comments
Open

Document the env option to dj_database_url.config #248

edmorley opened this issue May 24, 2024 · 2 comments

Comments

@edmorley
Copy link
Contributor

dj_database_url.config takes an env option that allows for customising the env var used for the database URL away from the default of DATABASE_URL:

def config(
env: str = DEFAULT_ENV,

However, this option isn't documented in the README:
https://github.com/jazzband/dj-database-url/blob/7906f3bf800105e6ab33bfbf44e6863fd178295a/README.rst#usage

Customising the env var is needed in the case of multiple DBs, where everything but the primary has to use something other than DATABASE_URL.

@lino
Copy link
Contributor

lino commented Oct 3, 2024

I believe this issue has been resolved by your own contribution? Thank you.

@edmorley
Copy link
Contributor Author

edmorley commented Oct 3, 2024

Hi! I'm not sure I follow?

This issue is about the env argument to dj_database_url.config not being documented in the README of this repo.

Checking the README now (using cmd+F -> search for "env") there is still no documentation of the env arg.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants