Skip to content

Commit b12ba72

Browse files
authored
Merge pull request #202 from Bost/master
pipenv installation instructions
2 parents 4966f5b + f1b2c1b commit b12ba72

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,16 @@ You will need the following things properly installed on your computer.
398398

399399
* `git clone https://github.com/ExpDev07/coronavirus-tracker-api.git`
400400
* `cd coronavirus-tracker-api`
401-
* `pipenv shell`
402-
* `pipenv install`
401+
402+
1. Make sure you have [`python3.8` installed and on your `PATH`](https://docs.python-guide.org/starting/installation/).
403+
2. [Install the `pipenv` dependency manager](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv)
404+
* with [pipx](https://pipxproject.github.io/pipx/) `$ pipx install pipenv`
405+
* with [Homebrew/Linuxbrew](https://pipenv.readthedocs.io/en/latest/install/#homebrew-installation-of-pipenv) `$ brew install pipenv`
406+
* with [pip/pip3 directly](https://pipenv.readthedocs.io/en/latest/install/#pragmatic-installation-of-pipenv) `$ pip install --user pipenv`
407+
3. Create virtual environment and install all dependencies `$ pipenv sync --dev`
408+
4. Activate/enter the virtual environment `$ pipenv shell`
409+
410+
And don't despair if don't get the python setup working on the first try. No one did. Guido got pretty close... once. But that's another story. Good luck.
403411

404412
## Running / Development
405413

@@ -408,11 +416,31 @@ You will need the following things properly installed on your computer.
408416

409417
### Running Tests
410418

411-
* `make test`
419+
```bash
420+
pipenv sync --dev
421+
pipenv shell
422+
make test
423+
```
412424

413425
### Linting
414426

415-
* `make lint`
427+
```bash
428+
pipenv sync --dev
429+
pipenv shell
430+
make lint
431+
```
432+
433+
### Formatting
434+
435+
```bash
436+
pipenv run fmt
437+
```
438+
or
439+
```bash
440+
pipenv shell
441+
make fmt
442+
```
443+
416444

417445
### Building
418446

0 commit comments

Comments
 (0)