Commit 540fa833d54457671c3ddac5c811da90c2e1553b
1 parent
c658ec80
Exists in
dev
New requirements.in file for the Sphinx RST doc (managed via pip-tools)
Showing
5 changed files
with
167 additions
and
30 deletions
Show diff stats
Dockerfile
... | ... | @@ -109,6 +109,15 @@ ENV PATH "$PATH:/home/pyros_user/.local/bin" |
109 | 109 | # Installing click on the image to prevent error on the first execution of the installation script |
110 | 110 | RUN pip install --user click |
111 | 111 | |
112 | +# (EP 23/3/2022) Installing pip-tools for the management of all the requirements*.txt files (python dependencies packages) | |
113 | +# NB : | |
114 | +# - pip-tools generates a smarter and smaller requirements.txt file than the traditional "pip freeze" | |
115 | +# - pip-tools is also better than the traditional "pip install -r" for installing the python packages | |
116 | +# - Unfortunatly, it is difficult to use with several requirements*.txt files as it is the case for this software : pyros + sphinx + guitastro... | |
117 | +# - So we cannot yet use it completely and still have to use the traditional "pip install -r" anyway ... | |
118 | +# - But we can at least use it to generate all the requirements*.txt files in a far better format | |
119 | +RUN pip install --user pip-tools | |
120 | + | |
112 | 121 | # Installing packages required for PyROS |
113 | 122 | RUN pip install --user -r ./install/requirements.txt |
114 | 123 | RUN pip install --user -r ./install/requirements_dev.txt | ... | ... |
... | ... | @@ -0,0 +1,34 @@ |
1 | + | |
2 | +# Main Sphinx package (called "Sphinx" or "sphinx") | |
3 | +Sphinx==4.4.0 | |
4 | + | |
5 | +sphinx-autodoc-typehints==1.17.0 | |
6 | + | |
7 | +# Extensions | |
8 | +autodocsumm==0.2.7 | |
9 | + | |
10 | +# Themes | |
11 | +#alabaster | |
12 | +sphinx-rtd-theme==1.0.0 | |
13 | + | |
14 | +# Builder (pdf) | |
15 | +rst2pdf==0.99 | |
16 | +#rstcheck | |
17 | + | |
18 | +# For pyreverse (included in pylint) | |
19 | +pylint==2.12.2 | |
20 | +graphviz==0.19.1 | |
21 | +pygraphviz==1.9 | |
22 | +sphinx-pyreverse==0.0.17 | |
23 | + | |
24 | +# Graphviz : for generating png diagrams from pyreverse | |
25 | +# Par défaut, seuls deux formats de sortie sont possibles : dot et vcg. | |
26 | +# Il est possible d'augmenter la quantité des formats de sortie avec l'installation de GraphViz | |
27 | +# See https://graphviz.org/download | |
28 | +# - Ubuntu & Debian : | |
29 | +#sudo apt install graphviz | |
30 | +# - Fedora & CentOS : | |
31 | +#sudo yum install graphviz | |
32 | +# - Mac : | |
33 | +#brew install graphviz | |
34 | + | ... | ... |
doc/doc_rst/requirements.txt
1 | -Sphinx | |
2 | -sphinx-autodoc-typehints | |
3 | - | |
4 | -# Extensions | |
5 | -autodocsumm | |
6 | - | |
7 | -# Themes | |
8 | -#alabaster | |
9 | -sphinx-rtd-theme | |
10 | - | |
11 | -# Builder (pdf) | |
12 | -rst2pdf | |
13 | -#rstcheck | |
14 | - | |
15 | -# For pyreverse (included in pylint) | |
16 | -pylint | |
17 | -graphviz | |
18 | -pygraphviz | |
19 | -sphinx_pyreverse | |
20 | - | |
21 | -# Graphviz : for generating png diagrams from pyreverse | |
22 | -# Par défaut, seuls deux formats de sortie sont possibles : dot et vcg. | |
23 | -# Il est possible d'augmenter la quantité des formats de sortie avec l'installation de GraphViz | |
24 | -# See https://graphviz.org/download | |
25 | -# - Ubuntu & Debian : | |
26 | -#sudo apt install graphviz | |
27 | -# - Fedora & CentOS : | |
28 | -#sudo yum install graphviz | |
29 | -# - Mac : | |
30 | -#brew install graphviz | |
1 | +# | |
2 | +# This file is autogenerated by pip-compile with python 3.8 | |
3 | +# To update, run: | |
4 | +# | |
5 | +# pip-compile requirements.in | |
6 | +# | |
7 | +alabaster==0.7.12 | |
8 | + # via sphinx | |
9 | +astroid==2.9.3 | |
10 | + # via | |
11 | + # pylint | |
12 | + # sphinx-pyreverse | |
13 | +autodocsumm==0.2.7 | |
14 | + # via -r requirements.in | |
15 | +babel==2.9.1 | |
16 | + # via sphinx | |
17 | +certifi==2021.10.8 | |
18 | + # via requests | |
19 | +charset-normalizer==2.0.12 | |
20 | + # via requests | |
21 | +docutils==0.17.1 | |
22 | + # via | |
23 | + # rst2pdf | |
24 | + # sphinx | |
25 | + # sphinx-pyreverse | |
26 | + # sphinx-rtd-theme | |
27 | +graphviz==0.19.1 | |
28 | + # via -r requirements.in | |
29 | +idna==3.3 | |
30 | + # via requests | |
31 | +imagesize==1.3.0 | |
32 | + # via sphinx | |
33 | +importlib-metadata==4.11.3 | |
34 | + # via | |
35 | + # rst2pdf | |
36 | + # sphinx | |
37 | +isort==5.10.1 | |
38 | + # via pylint | |
39 | +jinja2==3.0.3 | |
40 | + # via | |
41 | + # rst2pdf | |
42 | + # sphinx | |
43 | +lazy-object-proxy==1.7.1 | |
44 | + # via astroid | |
45 | +markupsafe==2.1.1 | |
46 | + # via jinja2 | |
47 | +mccabe==0.6.1 | |
48 | + # via pylint | |
49 | +packaging==21.3 | |
50 | + # via | |
51 | + # rst2pdf | |
52 | + # sphinx | |
53 | +pillow==9.0.1 | |
54 | + # via reportlab | |
55 | +platformdirs==2.5.1 | |
56 | + # via pylint | |
57 | +pygments==2.11.2 | |
58 | + # via | |
59 | + # rst2pdf | |
60 | + # sphinx | |
61 | +pygraphviz==1.9 | |
62 | + # via -r requirements.in | |
63 | +pylint==2.12.2 | |
64 | + # via | |
65 | + # -r requirements.in | |
66 | + # sphinx-pyreverse | |
67 | +pyparsing==3.0.7 | |
68 | + # via packaging | |
69 | +pytz==2022.1 | |
70 | + # via babel | |
71 | +pyyaml==6.0 | |
72 | + # via rst2pdf | |
73 | +reportlab==3.6.8 | |
74 | + # via rst2pdf | |
75 | +requests==2.27.1 | |
76 | + # via sphinx | |
77 | +rst2pdf==0.99 | |
78 | + # via -r requirements.in | |
79 | +smartypants==2.0.1 | |
80 | + # via rst2pdf | |
81 | +snowballstemmer==2.2.0 | |
82 | + # via sphinx | |
83 | +sphinx==4.4.0 | |
84 | + # via | |
85 | + # -r requirements.in | |
86 | + # autodocsumm | |
87 | + # sphinx-autodoc-typehints | |
88 | + # sphinx-pyreverse | |
89 | + # sphinx-rtd-theme | |
90 | +sphinx-autodoc-typehints==1.17.0 | |
91 | + # via -r requirements.in | |
92 | +sphinx-pyreverse==0.0.17 | |
93 | + # via -r requirements.in | |
94 | +sphinx-rtd-theme==1.0.0 | |
95 | + # via -r requirements.in | |
96 | +sphinxcontrib-applehelp==1.0.2 | |
97 | + # via sphinx | |
98 | +sphinxcontrib-devhelp==1.0.2 | |
99 | + # via sphinx | |
100 | +sphinxcontrib-htmlhelp==2.0.0 | |
101 | + # via sphinx | |
102 | +sphinxcontrib-jsmath==1.0.1 | |
103 | + # via sphinx | |
104 | +sphinxcontrib-qthelp==1.0.3 | |
105 | + # via sphinx | |
106 | +sphinxcontrib-serializinghtml==1.1.5 | |
107 | + # via sphinx | |
108 | +toml==0.10.2 | |
109 | + # via pylint | |
110 | +typing-extensions==4.1.1 | |
111 | + # via | |
112 | + # astroid | |
113 | + # pylint | |
114 | +urllib3==1.26.9 | |
115 | + # via requests | |
116 | +wrapt==1.13.3 | |
117 | + # via astroid | |
118 | +zipp==3.7.0 | |
119 | + # via importlib-metadata | |
31 | 120 | |
121 | +# The following packages are considered to be unsafe in a requirements file: | |
122 | +# setuptools | ... | ... |
docker/PYROS_DOCKER_BUILD.bat
pyros_api.py
... | ... | @@ -13,6 +13,7 @@ class PyrosAPI: |
13 | 13 | Request Pyros API with an PyrosUser account linked to the username and password |
14 | 14 | """ |
15 | 15 | BASE_PYROS_URL = "http://localhost:8000/api/" |
16 | + #BASE_PYROS_URL = "http://pyros.irap.omp.eu/api/" | |
16 | 17 | |
17 | 18 | def __init__(self) -> None: |
18 | 19 | """ | ... | ... |