fasthep-toolbench 2025.6.1__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.
Files changed (29) hide show
  1. fasthep_toolbench-2025.6.1/.git_archival.txt +3 -0
  2. fasthep_toolbench-2025.6.1/.gitattributes +1 -0
  3. fasthep_toolbench-2025.6.1/.github/CONTRIBUTING.md +89 -0
  4. fasthep_toolbench-2025.6.1/.github/dependabot.yml +11 -0
  5. fasthep_toolbench-2025.6.1/.github/release.yml +5 -0
  6. fasthep_toolbench-2025.6.1/.github/workflows/cd.yml +57 -0
  7. fasthep_toolbench-2025.6.1/.github/workflows/ci.yml +67 -0
  8. fasthep_toolbench-2025.6.1/.gitignore +158 -0
  9. fasthep_toolbench-2025.6.1/.pre-commit-config.yaml +92 -0
  10. fasthep_toolbench-2025.6.1/.readthedocs.yaml +17 -0
  11. fasthep_toolbench-2025.6.1/LICENSE +202 -0
  12. fasthep_toolbench-2025.6.1/PKG-INFO +166 -0
  13. fasthep_toolbench-2025.6.1/README.md +125 -0
  14. fasthep_toolbench-2025.6.1/docs/conf.py +64 -0
  15. fasthep_toolbench-2025.6.1/docs/index.md +17 -0
  16. fasthep_toolbench-2025.6.1/noxfile.py +107 -0
  17. fasthep_toolbench-2025.6.1/pyproject.toml +162 -0
  18. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/__init__.py +11 -0
  19. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/_version.py +21 -0
  20. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/_version.pyi +4 -0
  21. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/display/__init__.py +0 -0
  22. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/display/console.py +139 -0
  23. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/logger.py +26 -0
  24. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/misc.py +99 -0
  25. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/package/__init__.py +18 -0
  26. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/package/_import.py +37 -0
  27. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/package/_version.py +76 -0
  28. fasthep_toolbench-2025.6.1/src/fasthep_toolbench/py.typed +0 -0
  29. fasthep_toolbench-2025.6.1/tests/test_package.py +9 -0
@@ -0,0 +1,3 @@
1
+ node: $Format:%H$
2
+ node-date: $Format:%cI$
3
+ describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
@@ -0,0 +1 @@
1
+ .git_archival.txt export-subst
@@ -0,0 +1,89 @@
1
+ See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed
2
+ description of best practices for developing scientific packages.
3
+
4
+ [spc-dev-intro]: https://learn.scientific-python.org/development/
5
+
6
+ # Quick development
7
+
8
+ The fastest way to start with development is to use nox. If you don't have nox,
9
+ you can use `pipx run nox` to run it without installing, or `pipx install nox`.
10
+ If you don't have pipx (pip for applications), then you can install with
11
+ `pip install pipx` (the only case were installing an application with regular
12
+ pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
13
+ `brew install pipx nox`.
14
+
15
+ To use, run `nox`. This will lint and test using every installed version of
16
+ Python on your system, skipping ones that are not installed. You can also run
17
+ specific jobs:
18
+
19
+ ```console
20
+ $ nox -s lint # Lint only
21
+ $ nox -s tests # Python tests
22
+ $ nox -s docs # Build and serve the docs
23
+ $ nox -s build # Make an SDist and wheel
24
+ ```
25
+
26
+ Nox handles everything for you, including setting up an temporary virtual
27
+ environment for each run.
28
+
29
+ # Setting up a development environment manually
30
+
31
+ You can set up a development environment by running:
32
+
33
+ ```bash
34
+ python3 -m venv .venv
35
+ source ./.venv/bin/activate
36
+ pip install -v -e .[dev]
37
+ ```
38
+
39
+ If you have the
40
+ [Python Launcher for Unix](https://github.com/brettcannon/python-launcher), you
41
+ can instead do:
42
+
43
+ ```bash
44
+ py -m venv .venv
45
+ py -m install -v -e .[dev]
46
+ ```
47
+
48
+ # Pre-commit
49
+
50
+ You should prepare pre-commit, which will help you by checking that commits pass
51
+ required checks:
52
+
53
+ ```bash
54
+ pip install pre-commit # or brew install pre-commit on macOS
55
+ pre-commit install # Will install a pre-commit hook into the git repo
56
+ ```
57
+
58
+ You can also/alternatively run `pre-commit run` (changes only) or
59
+ `pre-commit run --all-files` to check even without installing the hook.
60
+
61
+ # Testing
62
+
63
+ Use pytest to run the unit checks:
64
+
65
+ ```bash
66
+ pytest
67
+ ```
68
+
69
+ # Coverage
70
+
71
+ Use pytest-cov to generate coverage reports:
72
+
73
+ ```bash
74
+ pytest --cov=fasthep-toolbench
75
+ ```
76
+
77
+ # Building docs
78
+
79
+ You can build and serve the docs using:
80
+
81
+ ```bash
82
+ nox -s docs
83
+ ```
84
+
85
+ You can build the docs only with:
86
+
87
+ ```bash
88
+ nox -s docs --non-interactive
89
+ ```
@@ -0,0 +1,11 @@
1
+ version: 2
2
+ updates:
3
+ # Maintain dependencies for GitHub Actions
4
+ - package-ecosystem: "github-actions"
5
+ directory: "/"
6
+ schedule:
7
+ interval: "weekly"
8
+ groups:
9
+ actions:
10
+ patterns:
11
+ - "*"
@@ -0,0 +1,5 @@
1
+ changelog:
2
+ exclude:
3
+ authors:
4
+ - dependabot
5
+ - pre-commit-ci
@@ -0,0 +1,57 @@
1
+ name: CD
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ pull_request:
6
+ push:
7
+ branches:
8
+ - main
9
+ release:
10
+ types:
11
+ - published
12
+
13
+ concurrency:
14
+ group: ${{ github.workflow }}-${{ github.ref }}
15
+ cancel-in-progress: true
16
+
17
+ env:
18
+ # Many color libraries just need this to be set to any value, but at least
19
+ # one distinguishes color depth, where "3" -> "256-bit color".
20
+ FORCE_COLOR: 3
21
+
22
+ jobs:
23
+ dist:
24
+ name: Distribution build
25
+ runs-on: ubuntu-latest
26
+
27
+ steps:
28
+ - uses: actions/checkout@v4
29
+ with:
30
+ fetch-depth: 0
31
+
32
+ - uses: hynek/build-and-inspect-python-package@v2
33
+
34
+ publish:
35
+ needs: [dist]
36
+ name: Publish to PyPI
37
+ environment: pypi
38
+ permissions:
39
+ id-token: write
40
+ attestations: write
41
+ contents: read
42
+ runs-on: ubuntu-latest
43
+ if: github.event_name == 'release' && github.event.action == 'published'
44
+
45
+ steps:
46
+ - uses: actions/download-artifact@v4
47
+ with:
48
+ name: Packages
49
+ path: dist
50
+
51
+ - name: Generate artifact attestation for sdist and wheel
52
+ uses: actions/attest-build-provenance@v2.4.0
53
+ with:
54
+ subject-path: "dist/*"
55
+
56
+ - uses: pypa/gh-action-pypi-publish@release/v1
57
+ if: github.event_name == 'release' && github.event.action == 'published'
@@ -0,0 +1,67 @@
1
+ name: CI
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ pull_request:
6
+ push:
7
+ branches:
8
+ - main
9
+
10
+ concurrency:
11
+ group: ${{ github.workflow }}-${{ github.ref }}
12
+ cancel-in-progress: true
13
+
14
+ env:
15
+ # Many color libraries just need this to be set to any value, but at least
16
+ # one distinguishes color depth, where "3" -> "256-bit color".
17
+ FORCE_COLOR: 3
18
+
19
+ jobs:
20
+ pre-commit:
21
+ name: Format
22
+ runs-on: ubuntu-latest
23
+ steps:
24
+ - uses: actions/checkout@v4
25
+ with:
26
+ fetch-depth: 0
27
+ - uses: actions/setup-python@v5
28
+ with:
29
+ python-version: "3.x"
30
+ - uses: pre-commit/action@v3.0.1
31
+ with:
32
+ extra_args: --hook-stage manual --all-files
33
+ - name: Run PyLint
34
+ run: pipx run nox -s pylint -- --output-format=github
35
+
36
+ checks:
37
+ name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
38
+ runs-on: ${{ matrix.runs-on }}
39
+ needs: [pre-commit]
40
+ strategy:
41
+ fail-fast: false
42
+ matrix:
43
+ python-version: ["3.11", "3.13"]
44
+ runs-on: [ubuntu-latest]
45
+
46
+ steps:
47
+ - uses: actions/checkout@v4
48
+ with:
49
+ fetch-depth: 0
50
+
51
+ - uses: actions/setup-python@v5
52
+ with:
53
+ python-version: ${{ matrix.python-version }}
54
+ allow-prereleases: true
55
+
56
+ - name: Install package
57
+ run: python -m pip install .[test]
58
+
59
+ - name: Test package
60
+ run: >-
61
+ python -m pytest -ra --cov --cov-report=xml --cov-report=term
62
+ --durations=20
63
+
64
+ - name: Upload coverage report
65
+ uses: codecov/codecov-action@v5.4.3
66
+ with:
67
+ token: ${{ secrets.CODECOV_TOKEN }}
@@ -0,0 +1,158 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
98
+ __pypackages__/
99
+
100
+ # Celery stuff
101
+ celerybeat-schedule
102
+ celerybeat.pid
103
+
104
+ # SageMath parsed files
105
+ *.sage.py
106
+
107
+ # Environments
108
+ .env
109
+ .venv
110
+ env/
111
+ venv/
112
+ ENV/
113
+ env.bak/
114
+ venv.bak/
115
+
116
+ # Spyder project settings
117
+ .spyderproject
118
+ .spyproject
119
+
120
+ # Rope project settings
121
+ .ropeproject
122
+
123
+ # mkdocs documentation
124
+ /site
125
+
126
+ # mypy
127
+ .mypy_cache/
128
+ .dmypy.json
129
+ dmypy.json
130
+
131
+ # Pyre type checker
132
+ .pyre/
133
+
134
+ # pytype static type analyzer
135
+ .pytype/
136
+
137
+ # Cython debug symbols
138
+ cython_debug/
139
+
140
+ # setuptools_scm
141
+ src/*/_version.py
142
+
143
+
144
+ # ruff
145
+ .ruff_cache/
146
+
147
+ # OS specific stuff
148
+ .DS_Store
149
+ .DS_Store?
150
+ ._*
151
+ .Spotlight-V100
152
+ .Trashes
153
+ ehthumbs.db
154
+ Thumbs.db
155
+
156
+ # Common editor files
157
+ *~
158
+ *.swp
@@ -0,0 +1,92 @@
1
+ ci:
2
+ autoupdate_commit_msg: "chore: update pre-commit hooks"
3
+ autofix_commit_msg: "style: pre-commit fixes"
4
+
5
+ exclude: ^.cruft.json|.copier-answers.yml$
6
+
7
+ repos:
8
+ - repo: https://github.com/adamchainz/blacken-docs
9
+ rev: "1.19.1"
10
+ hooks:
11
+ - id: blacken-docs
12
+ additional_dependencies: [black==24.*]
13
+
14
+ - repo: https://github.com/pre-commit/pre-commit-hooks
15
+ rev: "v5.0.0"
16
+ hooks:
17
+ - id: check-added-large-files
18
+ - id: check-case-conflict
19
+ - id: check-merge-conflict
20
+ - id: check-symlinks
21
+ - id: check-yaml
22
+ - id: debug-statements
23
+ - id: end-of-file-fixer
24
+ - id: mixed-line-ending
25
+ - id: name-tests-test
26
+ args: ["--pytest-test-first"]
27
+ - id: requirements-txt-fixer
28
+ - id: trailing-whitespace
29
+
30
+ - repo: https://github.com/pre-commit/pygrep-hooks
31
+ rev: "v1.10.0"
32
+ hooks:
33
+ - id: rst-backticks
34
+ - id: rst-directive-colons
35
+ - id: rst-inline-touching-normal
36
+
37
+ - repo: https://github.com/rbubley/mirrors-prettier
38
+ rev: "v3.5.3"
39
+ hooks:
40
+ - id: prettier
41
+ types_or: [yaml, markdown, html, css, scss, javascript, json]
42
+ args: [--prose-wrap=always]
43
+
44
+ - repo: https://github.com/astral-sh/ruff-pre-commit
45
+ rev: "v0.11.2"
46
+ hooks:
47
+ - id: ruff
48
+ args: ["--fix", "--show-fixes"]
49
+ - id: ruff-format
50
+
51
+ - repo: https://github.com/pre-commit/mirrors-mypy
52
+ rev: "v1.15.0"
53
+ hooks:
54
+ - id: mypy
55
+ files: src|tests
56
+ args: []
57
+ additional_dependencies:
58
+ - loguru
59
+ - pytest
60
+ - rich
61
+ - types-tabulate
62
+
63
+ - repo: https://github.com/codespell-project/codespell
64
+ rev: "v2.4.1"
65
+ hooks:
66
+ - id: codespell
67
+
68
+ - repo: https://github.com/shellcheck-py/shellcheck-py
69
+ rev: "v0.10.0.1"
70
+ hooks:
71
+ - id: shellcheck
72
+
73
+ - repo: local
74
+ hooks:
75
+ - id: disallow-caps
76
+ name: Disallow improper capitalization
77
+ language: pygrep
78
+ entry: PyBind|Numpy|Cmake|CCache|Github|PyTest
79
+ exclude: .pre-commit-config.yaml
80
+
81
+ - repo: https://github.com/abravalheri/validate-pyproject
82
+ rev: "v0.24.1"
83
+ hooks:
84
+ - id: validate-pyproject
85
+ additional_dependencies: ["validate-pyproject-schema-store[all]"]
86
+
87
+ - repo: https://github.com/python-jsonschema/check-jsonschema
88
+ rev: "0.31.3"
89
+ hooks:
90
+ - id: check-dependabot
91
+ - id: check-github-workflows
92
+ - id: check-readthedocs
@@ -0,0 +1,17 @@
1
+ # Read the Docs configuration file
2
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
+
4
+ version: 2
5
+
6
+ build:
7
+ os: ubuntu-22.04
8
+ tools:
9
+ python: "3.12"
10
+ commands:
11
+ - asdf plugin add uv
12
+ - asdf install uv latest
13
+ - asdf global uv latest
14
+ - uv venv
15
+ - uv pip install .[docs]
16
+ - .venv/bin/python -m sphinx -T -b html -d docs/_build/doctrees -D
17
+ language=en docs $READTHEDOCS_OUTPUT/html