forked from pympler/pympler
-
Notifications
You must be signed in to change notification settings - Fork 0
/
developer-notes.txt
58 lines (47 loc) · 1.45 KB
/
developer-notes.txt
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
Check-in new revision
=====================
* update CHANGELOG if necessary
* run the test suite
$ run.py --test [--clean]
* run the doctests
$ run.py --doctest
Release a new version
=====================
Tests
-----
* run the test suite
$ run.py --test [--clean]
* make sure the tests pass for all supported Python versions, e.g.
$ python3.4 run.py --test --clean
* there is also a bash script to test Pympler on multiple Python versions
$ bash tools/release_test.sh
* check test coverage with coverage.py (http://nedbatchelder.com/code/coverage/)
$ coverage run test/runtest.py
$ coverage html
Docs
----
* check that the documentation builds
$ run.py --html --verbose=1
* check if doctests pass
$ run.py --doctest --verbose=1
* check links
$ run.py --linkcheck --verbose=1
* build the documentation
$ run.py --html --keep
Checks
------
* check the meta data specified in pympler/metadata.py
* check the CHANGELOG file for missing entries
* check the NOTICE file for missing contributors
* check the to-be-released module distributions
$ run.py --dist [--html --keep]
Release
-------
* clean the working copy from any local changes
* build the source distribution
$ python setup.py sdist
* test installing the build in a new virtual env
$ pip install dist/Pympler-X.X.tar.gz
* release a new version to the Python package index
$ twine upload dist/Pympler-X.X.tar.gz
* check the documentation at https://pympler.readthedocs.io/en/latest/