Files
@ d32cbe382db9
Branch filter:
Location: gimmecert/docs/development.rst
d32cbe382db9
3.1 KiB
text/prs.fallenstein.rst
GC-3: Compatability fixes for OpenSSL 1.0/1.1 differences in output.
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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | .. Copyright (C) 2018 Branko Majic
This file is part of Gimmecert documentation.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
Unported License. To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
Development
===========
This section provides information on development process for the
project, including instructions on how to set-up a development
environment or run the tests locally.
Preparing development environment
---------------------------------
There is a number of different ways a development environment can be
set-up. The process outlined here is centered around
`virtualenvwrapper
<https://virtualenvwrapper.readthedocs.io/>`_. Instructions have been
tailored for a GNU/Linux system.
Before proceeding, ensure you have the following system-wide packages
installed:
- `Python, version 3.4+ <https://www.python.org/>`_.
- `virtualenvwrapper <https://virtualenvwrapper.readthedocs.io/>`_.
With those in place, do the following:
1. Clone the git repository::
git clone https://code.majic.rs/gimmecert/
2. Change directory::
cd gimmecert/
3. Create Python virtual environment:
.. warning::
Make sure to specify Python 3 as interpreter.
::
mkvirtualenv -a . -p /usr/bin/python3 gimmecert
4. Install development requirements::
pip install -e .[devel]
5. At this point, any time you want to run tests etc, you can easily
switch to correct environment (this will also put you in project
root directory) with::
workon gimmecert
Testing
-------
Project includes both unit tests (within ``tests/`` directory) , and
functional tests (within ``functional_tests/`` directory).
Running the tests will also generate coverage report in HTML format,
stored within directory ``coverage/``.
Tests can be run in a number of different ways, depending on what you
want to test and how.
To run the unit tests via setup script, run the following command from
repository root::
python setup.py test
To run the unit tests directly, run the following command from
repository root::
pytest
Functional tests must be run explicitly (since they tend to take more
time), with::
pytest functional_tests/
Linting checks are performed as part of testing. Linting checks can
easily be run with command::
flake8
Tests can also be run using `tox <https://tox.readthedocs.io/>`_:
.. note::
When running tests via ``tox``, functional tests are included as
well.
::
# Run full suite of tests on all supported Python versions.
tox
# List available tox environments.
tox -l
# Run tests against specific Python version.
tox -e py35
# Run documentation and linting tests only.
tox -e doc,lint
Building documentation
----------------------
Documentation is written in `reStructuredText
<https://en.wikipedia.org/wiki/ReStructuredText>`_ and built via
`Sphinx <http://www.sphinx-doc.org/>`_.
To build documentation, run::
cd docs/
make html
Resulting documentation will be stored in HTML format in directory
``docs/_build/html/``.
|