Newer
Older
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
*************
Get Involved
*************
We use `tox`_ as the development interface.
.. _tox: http://tox.readthedocs.io/
Run tests
---------
.. code-block:: bash
tox -e test
Lint source
-----------
.. code-block:: bash
tox -e lint
Format source
-------------
.. code-block:: bash
tox -e format
Type check source
-----------------
.. code-block:: bash
tox -e type
Development install
-------------------
.. code-block:: bash
$ pip install -e .'[test,lint,format,type,docs,pkg]'
Add a new dependency
--------------------
You add to the `install_requires`_ entry in the `setup.cfg`_.
.. _install_requires: https://setuptools.readthedocs.io/en/latest/setuptools.html#options
.. _setup.cfg: ./setup.cfg
Release Process
---------------
.. code-block:: bash
$ git tag x.x.x
$ git push --tags
Test release
============
.. code-block:: bash
$ tox -e metadata-release
$ tox -e test-release
Validate that you can install the package:
.. code-block:: bash
$ pip install -i https://test.pypi.org/simple/ librehosters-cli
$ pip show librehosters-cli
Production release
==================
.. code-block:: bash
$ tox -e metadata-release
$ tox -e prod-release
Validate that you can install the package:
.. code-block:: bash
$ pip install librehosters-cli
$ pip show librehosters-cli