@@ -11,36 +11,35 @@ mailing list`_, to ask questions or get involved.
11
11
Getting started
12
12
---------------
13
13
14
- We recommend you use a `virtual environment `_, so that twine and its
15
- dependencies do not interfere with other packages installed on your
16
- machine.
17
-
18
- Clone the twine repository from GitHub, then make and activate a
19
- virtual environment that uses Python 3.6 or newer as the default
20
- Python. For example:
14
+ We use `tox `_ to run tests, check code style, and build the documentation.
15
+ To install ``tox ``, run:
21
16
22
17
.. code-block :: console
23
18
24
- cd /path/to/your/local/twine
25
- python3.6 -m venv venv
26
- source venv/bin/activate
19
+ python3 -m pip install tox
27
20
28
- Then, run the following commands :
21
+ Clone the twine repository from GitHub, then run :
29
22
30
23
.. code-block :: console
31
24
32
- pip install -U pip
33
- pip install -e .
25
+ cd /path/to/your/local/twine
26
+ tox -e dev
34
27
35
- Now, in your virtual environment, ``twine `` is pointing at your local copy, so
36
- when you make changes, you can easily see their effect.
28
+ This creates a `virtual environment `_, so that twine and its
29
+ dependencies do not interfere with other packages installed on your
30
+ machine. In the virtual environment, ``twine `` is pointing at your
31
+ local copy, so when you make changes, you can easily see their effect.
37
32
38
- We use `tox `_ to run tests, check code style, and build the documentation.
39
- To install ``tox `` in your active virtual environment, run:
33
+ The virtual environment also contains the tools for running tests
34
+ and checking code style, so you can run them on single files directly or
35
+ in your code editor. However, we still encourage using the ``tox `` commands
36
+ below on the whole codebase.
37
+
38
+ To use the virtual environment, run:
40
39
41
40
.. code-block :: console
42
41
43
- pip install tox
42
+ source venv/bin/activate
44
43
45
44
Building the documentation
46
45
^^^^^^^^^^^^^^^^^^^^^^^^^^
0 commit comments