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
|
Contribute
==========
You want to add some code to cssselect2, launch its tests or improve its
documentation? Thank you very much! Here are some tips to help you play with
cssselect2 in good conditions.
The first step is to clone the repository, create a virtual environment and
install cssselect2 dependencies.
.. code-block:: shell
git clone https://github.com/Kozea/cssselect2.git
cd cssselect2
python -m venv venv
venv/bin/pip install .[doc,test]
You can then let your terminal in the current directory and launch Python to
test your changes. ``import cssselect2`` will then import the working directory
code, so that you can modify it and test your changes.
.. code-block:: shell
venv/bin/python
Code & Issues
-------------
If you’ve found a bug in cssselect2, it’s time to report it, and to fix it if you
can!
You can report bugs and feature requests on `GitHub`_. If you want to add or
fix some code, please fork the repository and create a pull request, we’ll be
happy to review your work.
.. _GitHub: https://github.com/Kozea/cssselect2
Tests
-----
Tests are stored in the ``tests`` folder at the top of the repository. They use
the `pytest`_ library.
You can launch tests using the following command::
venv/bin/python -m pytest
cssselect2 also uses ruff_ to check the coding style::
venv/bin/python -m ruff check
.. _pytest: https://docs.pytest.org/
.. _ruff: https://docs.astral.sh/ruff/
Documentation
-------------
Documentation is stored in the ``docs`` folder at the top of the repository. It
relies on the `Sphinx`_ library.
You can build the documentation using the following command::
venv/bin/sphinx-build docs docs/_build
The documentation home page can now be found in the ``docs/_build/index.html``
file. You can open this file in a browser to see the final rendering.
.. _Sphinx: https://www.sphinx-doc.org/
|
