678
88%

Ran 27 Dec 2020 07:29PM UTC

Jobs 9

Files 8

Run time 56s

Badge

Embed ▾

pending completion

Build # 678

Build Type

push

travis-ci-com

Committed by

web-flow

Commit Message

Rewrite readme (#294)

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.

Run Details

423 of 479 relevant lines covered (88.31%)

6.14 hits per line

Jobs

ID	Job ID	Ran	Coverage
1	678.1 (TOXENV=lint)	27 Dec 2020 07:29PM UTC	0.0	Travis Job 678.1
2	678.2 (TOXENV=manifest)	27 Dec 2020 07:29PM UTC	0.0	Travis Job 678.2
3	678.3 (TOXENV=py27)	27 Dec 2020 07:29PM UTC	87.68	Travis Job 678.3
4	678.4 (TOXENV=py35)	27 Dec 2020 07:29PM UTC	87.68	Travis Job 678.4
5	678.5 (TOXENV=py36)	27 Dec 2020 07:29PM UTC	87.68	Travis Job 678.5
6	678.6 (TOXENV=py37)	27 Dec 2020 07:29PM UTC	87.68	Travis Job 678.6
7	678.7 (TOXENV=py38)	27 Dec 2020 07:29PM UTC	87.93	Travis Job 678.7
8	678.8 (TOXENV=py39)	27 Dec 2020 07:29PM UTC	87.93	Travis Job 678.8
10	678.10 (TOXENV=pypy3)	27 Dec 2020 07:30PM UTC	87.68	Travis Job 678.10

Source Files on build 678

Detailed source file information is not available for this build.

theskumar / python-dotenv / 678
88%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 678

theskumar / python-dotenv / 678 88%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 678

theskumar / python-dotenv / 678
88%

README BADGES
x