aboutsummaryrefslogtreecommitdiff
path: root/docs/developers.rst
blob: 17307cd025b37cb8ea4ad0eeeadb6b0a8b13fa98 (plain)
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
Developers
==========

Install requirements
--------------------

.. include:: ../requirements-dev.txt
   :literal:

.. code-block::

    $ pip3 instal -r requirements-dev.txt

Install in *editable* mode
--------------------------

.. code-block::

    $ git clone https://github.com/cacharle/minishell_test
    $ cd minishell_test
    $ pip3 install -e .

This make it possible to modify the source and see the changes live.

Linting
-------

.. code-block::

    $ flake8 minishell_test

Type checking
-------------

.. code-block::

    $ mypy minishell_test

Unit Test
---------

.. code-block::

    $ pytest

Cross environment testing
-------------------------

.. code-block::

    $ tox