File: CHEATSHEET.rst

package info (click to toggle)
python-outcome 1.2.0-1.1
  • links: PTS
  • area: main
  • in suites: sid, trixie
  • size: 184 kB
  • sloc: python: 335; makefile: 12
file content (42 lines) | stat: -rw-r--r-- 795 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Tips
====

To run tests
------------

* Install requirements: ``pip install -r test-requirements.txt``
  (possibly in a virtualenv)

* Actually run the tests: ``pytest tests``


To run yapf
-----------

* Show what changes yapf wants to make: ``yapf -rpd setup.py
  src tests``

* Apply all changes directly to the source tree: ``yapf -rpi setup.py
  src tests``


To make a release
-----------------

* Update the version in ``outcome/_version.py``

* Run ``towncrier`` to collect your release notes.

* Review your release notes.

* Check everything in.

* Double-check it all works, docs build, etc.

* Build your sdist and wheel: ``python setup.py sdist bdist_wheel``

* Upload to PyPI: ``twine upload dist/*``

* Use ``git tag`` to tag your version.

* Don't forget to ``git push --tags``.