Skip to content

Commit

Permalink
docs: add guide to use pipx (#78)
Browse files Browse the repository at this point in the history
* add guide using pipx

* fix markdown length
  • Loading branch information
yanksyoon committed May 29, 2024
1 parent a8df1ef commit 72ece14
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions development-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,16 @@ depending on the version of Python charm uses. For example:
```bash
pyenv install 3.10.7
pyenv global 3.10.7
cd PATH/TO/REPOSITORY
python -m virtualenv venv
```
Install pyenv by following the
[installation guide](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation).
Python [build dependencies](https://github.com/pyenv/pyenv?tab=readme-ov-file#install-python-build-dependencies)
may need to be pre-installed before installing additional Python versions.

- [pipx](https://github.com/pypa/pipx)

Pipx is recommended to install Python applications (i.e. pflake8) in an isolated
environment without modifying your system dependencies.

### VS Code

Expand Down Expand Up @@ -63,14 +70,13 @@ helps setup tools to follow project configurations setup in `pyproject.toml`.
- [flake8](https://marketplace.visualstudio.com/items?itemName=ms-python.flake8)

Default flake8 cannot be used to read the project settings.
Using pyproject-flake8 is required.
Using pyproject-flake8 is required to read from pyproject.toml.

1. Install VS Code flake8 extension
2. pip install flake 8 and it's plugins
2. pipx install flake 8 and it's plugins
```bash
pip install flake8 flake8-docstrings \
flake8-copyright flake8-builtins \
pyproject-flake8 pep8-naming
pipx install pyproject-flake8
pipx inject flake8-docstrings flake8-copyright flake8-builtins pep8-naming
```
1. Change the flake 8 to point to pflake8 installed above by modifying the
*Flake8: Path* entry in Settings(UI) or
Expand Down Expand Up @@ -109,6 +115,14 @@ excludesFile = ~/.gitignore_global
]
```

### Tox

Use pipx to install tox.

```bash
pipx install tox
```

### Signed Commits

* Make sure `gpg` is installed:
Expand Down

0 comments on commit 72ece14

Please sign in to comment.