stouputils 1.2.33__tar.gz → 1.2.35__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {stouputils-1.2.33 → stouputils-1.2.35}/PKG-INFO +3 -3
- {stouputils-1.2.33 → stouputils-1.2.35}/pyproject.toml +3 -3
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/applications/automatic_docs.py +14 -5
- {stouputils-1.2.33 → stouputils-1.2.35}/.gitignore +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/LICENSE +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/README.md +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/__init__.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/all_doctests.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/applications/__init__.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/archive.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/backup.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/collections.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/continuous_delivery/__init__.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/continuous_delivery/cd_utils.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/continuous_delivery/github.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/continuous_delivery/pypi.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/continuous_delivery/pyproject.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/ctx.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/decorators.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/dont_look/zip_file_override.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/image.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/io.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/parallel.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/print.py +0 -0
- {stouputils-1.2.33 → stouputils-1.2.35}/stouputils/py.typed +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: stouputils
|
|
3
|
-
Version: 1.2.
|
|
3
|
+
Version: 1.2.35
|
|
4
4
|
Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
|
|
5
5
|
Project-URL: Homepage, https://github.com/Stoupy51/stouputils
|
|
6
6
|
Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues
|
|
@@ -9,10 +9,10 @@ License-File: LICENSE
|
|
|
9
9
|
Classifier: License :: OSI Approved :: MIT License
|
|
10
10
|
Classifier: Operating System :: OS Independent
|
|
11
11
|
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Requires-Python: >=3.
|
|
12
|
+
Requires-Python: >=3.10
|
|
13
13
|
Requires-Dist: numpy
|
|
14
14
|
Requires-Dist: opencv-python>=4.0.0
|
|
15
|
-
Requires-Dist: pillow>=
|
|
15
|
+
Requires-Dist: pillow>=11.0.0
|
|
16
16
|
Requires-Dist: pyyaml>=6.0.0
|
|
17
17
|
Requires-Dist: requests>=2.20.0
|
|
18
18
|
Requires-Dist: toml>=0.10.0
|
|
@@ -5,10 +5,10 @@ build-backend = "hatchling.build"
|
|
|
5
5
|
|
|
6
6
|
[project]
|
|
7
7
|
name = "stouputils"
|
|
8
|
-
version = "1.2.
|
|
8
|
+
version = "1.2.35"
|
|
9
9
|
description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
|
|
10
10
|
readme = "README.md"
|
|
11
|
-
requires-python = ">=3.
|
|
11
|
+
requires-python = ">=3.10"
|
|
12
12
|
classifiers = [
|
|
13
13
|
"Programming Language :: Python :: 3",
|
|
14
14
|
"License :: OSI Approved :: MIT License",
|
|
@@ -19,7 +19,7 @@ dependencies = [
|
|
|
19
19
|
"requests>=2.20.0",
|
|
20
20
|
"pyyaml>=6.0.0",
|
|
21
21
|
"toml>=0.10.0",
|
|
22
|
-
"pillow>=
|
|
22
|
+
"pillow>=11.0.0",
|
|
23
23
|
"numpy",
|
|
24
24
|
"opencv-python>=4.0.0",
|
|
25
25
|
]
|
|
@@ -52,7 +52,7 @@ Example of GitHub Actions workflow:
|
|
|
52
52
|
- uses: actions/setup-python@v5
|
|
53
53
|
- name: Install dependencies
|
|
54
54
|
run: |
|
|
55
|
-
pip install stouputils m2r2
|
|
55
|
+
pip install stouputils m2r2 myst_parser pydata_sphinx_theme
|
|
56
56
|
- name: Build version docs
|
|
57
57
|
run: |
|
|
58
58
|
python scripts/create_docs.py ${GITHUB_REF#refs/tags/v}
|
|
@@ -78,12 +78,16 @@ from ..continuous_delivery import version_to_float
|
|
|
78
78
|
from ..print import info
|
|
79
79
|
|
|
80
80
|
# Constants
|
|
81
|
-
REQUIREMENTS: list[str] = ["m2r2", "
|
|
81
|
+
REQUIREMENTS: list[str] = ["m2r2", "myst_parser"]
|
|
82
82
|
""" List of requirements for automatic_docs to work. """
|
|
83
83
|
|
|
84
84
|
# Functions
|
|
85
|
-
def check_dependencies() -> None:
|
|
86
|
-
""" Check for each requirement if it is installed.
|
|
85
|
+
def check_dependencies(html_theme: str) -> None:
|
|
86
|
+
""" Check for each requirement if it is installed.
|
|
87
|
+
|
|
88
|
+
Args:
|
|
89
|
+
html_theme (str): HTML theme to use for the documentation, to check if it is installed (e.g. "pydata_sphinx_theme", "sphinx_rtd_theme", "furo", etc.)
|
|
90
|
+
"""
|
|
87
91
|
import importlib
|
|
88
92
|
for requirement in REQUIREMENTS:
|
|
89
93
|
try:
|
|
@@ -92,6 +96,11 @@ def check_dependencies() -> None:
|
|
|
92
96
|
requirements_str: str = " ".join(REQUIREMENTS)
|
|
93
97
|
raise ImportError(f"{requirement} is not installed. Please install it the following requirements to use automatic_docs: '{requirements_str}'")
|
|
94
98
|
|
|
99
|
+
try:
|
|
100
|
+
importlib.import_module(html_theme)
|
|
101
|
+
except ImportError:
|
|
102
|
+
raise ImportError(f"{html_theme} is not installed. Please add it to your dependencies.")
|
|
103
|
+
|
|
95
104
|
def get_sphinx_conf_content(
|
|
96
105
|
project: str,
|
|
97
106
|
project_dir: str,
|
|
@@ -425,7 +434,7 @@ def update_documentation(
|
|
|
425
434
|
generate_redirect_function (Callable[[str], None]): Function to create redirect file
|
|
426
435
|
get_conf_content_function (Callable[..., str]): Function to get Sphinx conf.py content
|
|
427
436
|
"""
|
|
428
|
-
check_dependencies()
|
|
437
|
+
check_dependencies(html_theme)
|
|
429
438
|
|
|
430
439
|
# Setup paths
|
|
431
440
|
root_path = clean_path(root_path)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|