Skip to content

Commit

Permalink
Dont suggest [dev] install by default
Browse files Browse the repository at this point in the history
  • Loading branch information
patnr committed Feb 28, 2024
1 parent a21509a commit 2a99a4c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,19 +114,17 @@ Ensure the printed version is 3.9 or more.

- Download and unzip (or `git clone`) DAPPER.
- Move the resulting folder wherever you like,
and `cd` into it
*(ensure you're in the folder with a `setup.py` file)*.
- `pip install -e '.[dev]'`
You can omit `[dev]` if you don't need to do serious development.
and `cd` into it *(ensure you're in the folder with a `setup.py` file)*.
- `pip install -e '.'`

#### *Or*: Install as library

*Do you just want to run a script that requires DAPPER?* Then

- If the script comes with a `requirements.txt` file, then do
- If the script comes with a `requirements.txt` file that lists DAPPER, then do
`pip install -r path/to/requirements.txt`.
- If not, hopefully you know the version of DAPPER needed. Run
`pip install dapper==1.5.1` to get version `1.5.1` (as an example).
`pip install dapper==1.6.0` to get version `1.6.0` (as an example).

#### *Finally*: Test the installation

Expand Down
11 changes: 5 additions & 6 deletions docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,15 @@

## Install for development

Make sure you included the dev tools as part of the installation
(detailed in the README):
Include the dev tools as part of the installation (detailed in the README):

```sh
pip install -e .[dev]
pip install -e '.[dev]'
```

*If* you want to be able to use static analysis tools (`pyright`)
all the while use dapper from another directory, you should also **append**
`--config-settings editable_mode=compat` to the above command.
PS: *If* you want to be able to use static analysis tools (`pyright`) with dapper
all the while working *from outside its directory*,
you should also **append** `--config-settings editable_mode=compat` to the above command.
Ref [pyright doc](https://github.com/microsoft/pyright/blob/main/docs/import-resolution.md#editable-installs)
and [pyright issue](https://github.com/microsoft/pylance-release/issues/78).
Alternatively, there is the `extraPaths` setting.
Expand Down

0 comments on commit 2a99a4c

Please sign in to comment.