Commit 8e05bbb 1 parent b3488bf commit 8e05bbb Copy full SHA for 8e05bbb
File tree 1 file changed +7
-7
lines changed
1 file changed +7
-7
lines changed Original file line number Diff line number Diff line change 4
4
## Installation
5
5
` pip3 install running-ng `
6
6
7
+ There are two [ extras] ( https://peps.python.org/pep-0508/#extras ) available.
8
+ - ` zulip ` : dependencies for the ` Zulip ` ` runbms ` plugin, useful for users.
9
+ - ` tests ` : dependencies for running tests, useful for package developers.
10
+
7
11
## Development setup
8
- ``` console
12
+ ``` bash
9
13
virtualenv env
10
14
source env/bin/activate
11
- pip install -U pip setuptools build[virtualenv] twine
15
+ pip install -e .[zulip,tests]
16
+ pip install -U pip setuptools build[virtualenv] twine # extra packages for building releases
12
17
```
13
18
14
19
- To make a distribution archives, run ` python -m build ` within the virtual environment.
15
- - To run an editable build in the virtual environment, run ` pip install -e . ` .
16
20
- To install to user ` site-packages ` , run ` pip install dist/running_ng-<VERSION>-py3-none-any.whl ` outside the virtual environment.
17
21
- To update to PyPI, run ` twine upload --repository running-ng dist/*<VERSION>* ` .
18
22
19
- There are two [ extras] ( https://peps.python.org/pep-0508/#extras ) available.
20
- - ` zulip ` : dependencies for the ` Zulip ` ` runbms ` plugin.
21
- - ` tests ` : dependencies for running tests.
22
-
23
23
## Documentation
24
24
Please refer to [ this site] ( https://anupli.github.io/running-ng/ ) for up-to-date documentations.
25
25
You can’t perform that action at this time.
0 commit comments