/
development.txt
54 lines (35 loc) · 1.27 KB
/
development.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
Development
===========
.. highlight:: bash
This package is developed using continuous integration which can be
found here:
https://circleci.com/gh/Simplistix/mush
The latest development version of the documentation can be found here:
http://mush.readthedocs.org/en/latest/
If you wish to contribute to this project, then you should fork the
repository found here:
https://github.com/Simplistix/mush/
Once that has been done and you have a checkout, you can follow these
instructions to perform various development tasks:
Setting up a virtualenv
-----------------------
The recommended way to set up a development environment is to turn
your checkout into a virtualenv and then install the package in
editable form as follows::
$ virtualenv .
$ bin/pip install -U -e .[test,build]
Running the tests
-----------------
Once you have a buildout, the tests can be run as follows::
$ bin/pytest
Building the documentation
--------------------------
The Sphinx documentation is built by doing the following from the
directory containing setup.py::
$ cd docs
$ make html
Making a release
----------------
To make a release, just update the version in ``setup.py``,
update the change log and push to https://github.com/Simplistix/mush
and Carthorse should take care of the rest.