Skip to content

Commit f1b2c1b

Browse files
committed
update installation instructions
1 parent 78a189c commit f1b2c1b

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -399,14 +399,15 @@ You will need the following things properly installed on your computer.
399399
* `git clone https://github.com/ExpDev07/coronavirus-tracker-api.git`
400400
* `cd coronavirus-tracker-api`
401401

402-
Now, make sure you're running python 3.8 and that your `pipenv` actually uses it! It may use packages from `$HOME/.local/lib/python3.7` even when started with `pipenv --python 3.8`. To combat this, (re)install it using:
403-
```
404-
/path/to/python3.8 -m pip install pipenv
405-
```
406-
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.
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`
407409

408-
* `pipenv shell`
409-
* `pipenv install`
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.
410411

411412
## Running / Development
412413

@@ -416,19 +417,31 @@ And don't despair if don't get the python setup working on the first try. No one
416417
### Running Tests
417418

418419
```bash
420+
pipenv sync --dev
419421
pipenv shell
420-
pipenv install --dev
421422
make test
422423
```
423424

424425
### Linting
425426

426427
```bash
428+
pipenv sync --dev
427429
pipenv shell
428-
pipenv install --dev
429430
make lint
430431
```
431432

433+
### Formatting
434+
435+
```bash
436+
pipenv run fmt
437+
```
438+
or
439+
```bash
440+
pipenv shell
441+
make fmt
442+
```
443+
444+
432445
### Building
433446

434447
### Deploying

0 commit comments

Comments
 (0)