Skip to content

Conversation

@bbc2
Copy link
Collaborator

@bbc2 bbc2 commented Dec 27, 2020

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 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.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 88.309% when pulling 89bad24 on bbc2:new-readme into 26ff5b7 on theskumar:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 88.309% when pulling 89bad24 on bbc2:new-readme into 26ff5b7 on theskumar:master.

@theskumar
Copy link
Owner

This is gold! Thanks for making it look simple and clear enough.

@theskumar theskumar merged commit 2e0ea48 into theskumar:master Dec 27, 2020
@bbc2 bbc2 deleted the new-readme branch December 28, 2020 17:04
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.
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

Successfully merging this pull request may close these issues.

3 participants