Conversation
This mainly reorganizes the readme based on questions and feedback from
users on GitHub over the years:
- Getting Started: Short section which covers the main use case and
doesn't go into details.
- Pip command at the very beginning so that users are less likely to
mistakenly install another package.
- Basic application code to load the .env file into the environment.
- Introduction to the syntax of .env files with a short example.
- Other common use cases:
- Load configuration without altering the environment
- Parse configuration as a stream
- Load .env files in IPython
- Command-line Interface
- File format: Details about the syntax of .env files, previously
scattered around.
- Related Projects: I'm not sure we really need that one but I guess we can keep
it for now.
- Acknowledgements
Minor changes:
- I removed the "saythanks" link since it is dead.
- I removed the banner made in ASCII art since it read ".env" and not
"python-dotenv", which I found distracting. We could make another one
but I don't have time right now. It also saves the user some
scrolling.
1 similar comment
Owner
|
This is gold! Thanks for making it look simple and clear enough. |
johnbergvall
pushed a commit
to johnbergvall/python-dotenv
that referenced
this pull request
Aug 13, 2021
This mainly reorganizes the readme based on questions and feedback from
users on GitHub over the years:
- Getting Started: Short section which covers the main use case and
doesn't go into details.
- Pip command at the very beginning so that users are less likely to
mistakenly install another package.
- Basic application code to load the .env file into the environment.
- Introduction to the syntax of .env files with a short example.
- Other common use cases:
- Load configuration without altering the environment
- Parse configuration as a stream
- Load .env files in IPython
- Command-line Interface
- File format: Details about the syntax of .env files, previously
scattered around.
- Related Projects: I'm not sure we really need that one but I guess we can keep
it for now.
- Acknowledgements
Minor changes:
- I removed the "saythanks" link since it is dead.
- I removed the banner made in ASCII art since it read ".env" and not
"python-dotenv", which I found distracting. We could make another one
but I don't have time right now. It also saves the user some
scrolling.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This mainly reorganizes the readme based on questions and feedback from
users on GitHub over the years:
doesn't go into details.
mistakenly install another package.
scattered around.
it for now.
Minor changes:
"python-dotenv", which I found distracting. We could make another one
but I don't have time right now. It also saves the user some
scrolling.