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
|
.. _virtualenv: http://www.virtualenv.org
.. _pip: https://pip.pypa.io
.. _Pytest: http://pytest.org
.. _Napoleon: https://sphinxcontrib-napoleon.readthedocs.io
.. _Flake8: http://flake8.readthedocs.io
.. _Sphinx: http://www.sphinx-doc.org
.. _tox: http://tox.readthedocs.io
.. _sphinx-autobuild: https://github.com/GaretJax/sphinx-autobuild
===========
Development
===========
Development requirement
***********************
crispy-form-foundation is developed with:
* *Test Development Driven* (TDD) using `Pytest`_;
* Respecting flake and pip8 rules using `Flake8`_;
* `Sphinx`_ for documentation with enabled `Napoleon`_ extension (using
*Google style*);
* `tox`_ to run tests on various environments;
Install for development
***********************
First ensure you have `pip`_ and `virtualenv`_ packages installed then type: ::
git clone https://github.com/sveetch/crispy-forms-foundation.git
cd crispy-forms-foundation
make install
This will install the whole project in development mode.
To reach the administration you may need a super user: ::
make superuser
Unittests
---------
Unittests are made to works on `Pytest`_, a shortcut in Makefile is available
to start them on your current development install: ::
make tests
Tox
---
To ease development against multiple Python versions a tox configuration has
been added. You are encouraged to use it to test your pull requests to ensure about
compatibility support.
Just go in the ``crispy-forms-foundation`` directory and execute Tox: ::
make tox
Documentation
-------------
You can easily build the documentation from one Makefile action: ::
make docs
There is a Makefile action ``livedocs`` to serve documentation and automatically
rebuild it when you change documentation files: ::
make livedocs
And go on ``http://localhost:8002/`` or your server machine IP with port 8002.
Note that you need to build the documentation at least once before using
``livedocs``.
|
