Skip to content

Commit

Permalink
Improve development instructions
Browse files Browse the repository at this point in the history
- Use a virtual environment instead of installing stuff globally (which
  doesn’t work on my system anyway).
- Remove potentially confusing prompt characters from commands.
  • Loading branch information
jrosdahl committed Mar 8, 2021
1 parent 73249e6 commit e5994bc
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ Development
To install in development mode with all required development and testing
dependencies:

# pip3 install -e '.[dev]'
python3 -m venv venv
source venv/bin/activate
pip install -e '.[dev]'

To run the tests:

# ./test
./test


Packaging
Expand All @@ -19,10 +21,8 @@ will ensure that pep517 and twine are installed.

Build the wheel with pep517's build command:

# python3 -m pep517.build .
python3 -m pep517.build .

Upload new the version to PyPI:

# python3 -m twine upload dist/*


python3 -m twine upload dist/*

0 comments on commit e5994bc

Please sign in to comment.