acumen 0.0.1.dev0__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.
- acumen-0.0.1.dev0/.codecov.yaml +17 -0
- acumen-0.0.1.dev0/.cruft.json +44 -0
- acumen-0.0.1.dev0/.editorconfig +15 -0
- acumen-0.0.1.dev0/.github/ISSUE_TEMPLATE/bug_report.yml +93 -0
- acumen-0.0.1.dev0/.github/ISSUE_TEMPLATE/config.yml +5 -0
- acumen-0.0.1.dev0/.github/ISSUE_TEMPLATE/feature_request.yml +11 -0
- acumen-0.0.1.dev0/.github/workflows/build.yaml +26 -0
- acumen-0.0.1.dev0/.github/workflows/release.yaml +27 -0
- acumen-0.0.1.dev0/.github/workflows/test.yaml +107 -0
- acumen-0.0.1.dev0/.gitignore +34 -0
- acumen-0.0.1.dev0/.pre-commit-config.yaml +38 -0
- acumen-0.0.1.dev0/.readthedocs.yaml +16 -0
- acumen-0.0.1.dev0/.vscode/extensions.json +18 -0
- acumen-0.0.1.dev0/.vscode/launch.json +33 -0
- acumen-0.0.1.dev0/.vscode/settings.json +18 -0
- acumen-0.0.1.dev0/CHANGELOG.md +11 -0
- acumen-0.0.1.dev0/LICENSE +21 -0
- acumen-0.0.1.dev0/PKG-INFO +168 -0
- acumen-0.0.1.dev0/README.md +121 -0
- acumen-0.0.1.dev0/biome.jsonc +17 -0
- acumen-0.0.1.dev0/docs/_static/.gitkeep +0 -0
- acumen-0.0.1.dev0/docs/_static/css/custom.css +4 -0
- acumen-0.0.1.dev0/docs/_static/images/banner.svg +501 -0
- acumen-0.0.1.dev0/docs/_static/images/banner_plate.svg +9 -0
- acumen-0.0.1.dev0/docs/_static/images/logo.svg +47 -0
- acumen-0.0.1.dev0/docs/api.md +164 -0
- acumen-0.0.1.dev0/docs/changelog.md +3 -0
- acumen-0.0.1.dev0/docs/conf.py +137 -0
- acumen-0.0.1.dev0/docs/index.md +12 -0
- acumen-0.0.1.dev0/docs/references.bib +10 -0
- acumen-0.0.1.dev0/docs/references.md +5 -0
- acumen-0.0.1.dev0/pyproject.toml +152 -0
- acumen-0.0.1.dev0/src/acumen/__init__.py +160 -0
- acumen-0.0.1.dev0/src/acumen/_skills/__init__.py +0 -0
- acumen-0.0.1.dev0/src/acumen/_skills/data/SKILL.md +109 -0
- acumen-0.0.1.dev0/src/acumen/_skills/data/references/authoring.md +91 -0
- acumen-0.0.1.dev0/src/acumen/_skills/data/references/benchmark.md +100 -0
- acumen-0.0.1.dev0/src/acumen/_skills/data/references/python-api.md +106 -0
- acumen-0.0.1.dev0/src/acumen/_skills/data/references/setup.md +94 -0
- acumen-0.0.1.dev0/src/acumen/_skills/data/references/ship.md +53 -0
- acumen-0.0.1.dev0/src/acumen/_skills/install.py +185 -0
- acumen-0.0.1.dev0/src/acumen/assets/banner.svg +501 -0
- acumen-0.0.1.dev0/src/acumen/assets/logo.svg +47 -0
- acumen-0.0.1.dev0/src/acumen/bench.py +202 -0
- acumen-0.0.1.dev0/src/acumen/cli.py +626 -0
- acumen-0.0.1.dev0/src/acumen/config.py +204 -0
- acumen-0.0.1.dev0/src/acumen/draft.py +202 -0
- acumen-0.0.1.dev0/src/acumen/env.py +602 -0
- acumen-0.0.1.dev0/src/acumen/grade.py +104 -0
- acumen-0.0.1.dev0/src/acumen/improve.py +596 -0
- acumen-0.0.1.dev0/src/acumen/logs.py +255 -0
- acumen-0.0.1.dev0/src/acumen/paths.py +164 -0
- acumen-0.0.1.dev0/src/acumen/procs.py +195 -0
- acumen-0.0.1.dev0/src/acumen/prompts.py +942 -0
- acumen-0.0.1.dev0/src/acumen/report.py +1858 -0
- acumen-0.0.1.dev0/src/acumen/runner.py +343 -0
- acumen-0.0.1.dev0/src/acumen/sandbox.py +153 -0
- acumen-0.0.1.dev0/src/acumen/scaffold.py +118 -0
- acumen-0.0.1.dev0/src/acumen/ship.py +298 -0
- acumen-0.0.1.dev0/src/acumen/skills.py +298 -0
- acumen-0.0.1.dev0/src/acumen/taskgen.py +424 -0
- acumen-0.0.1.dev0/src/acumen/tasks.py +144 -0
- acumen-0.0.1.dev0/src/acumen/transcript.py +77 -0
- acumen-0.0.1.dev0/tests/conftest.py +134 -0
- acumen-0.0.1.dev0/tests/test_cli.py +207 -0
- acumen-0.0.1.dev0/tests/test_core.py +1252 -0
- acumen-0.0.1.dev0/tests/test_ship_install.py +136 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Based on pydata/xarray
|
|
2
|
+
codecov:
|
|
3
|
+
require_ci_to_pass: no
|
|
4
|
+
|
|
5
|
+
coverage:
|
|
6
|
+
status:
|
|
7
|
+
project:
|
|
8
|
+
default:
|
|
9
|
+
# Require 1% coverage, i.e., always succeed
|
|
10
|
+
target: 1
|
|
11
|
+
patch: false
|
|
12
|
+
changes: false
|
|
13
|
+
|
|
14
|
+
comment:
|
|
15
|
+
layout: diff, flags, files
|
|
16
|
+
behavior: once
|
|
17
|
+
require_base: no
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
{
|
|
2
|
+
"template": "https://github.com/scverse/cookiecutter-scverse",
|
|
3
|
+
"commit": "4e7f088d1b146b77460971ccfa5739099766ca52",
|
|
4
|
+
"checkout": null,
|
|
5
|
+
"context": {
|
|
6
|
+
"cookiecutter": {
|
|
7
|
+
"project_name": "acumen",
|
|
8
|
+
"package_name": "acumen",
|
|
9
|
+
"project_description": "A very interesting piece of code",
|
|
10
|
+
"author_full_name": "Pau Badia i Mompel",
|
|
11
|
+
"author_email": "paubim@stanford.edu",
|
|
12
|
+
"github_user": "scverse",
|
|
13
|
+
"github_repo": "acumen",
|
|
14
|
+
"license": "MIT License",
|
|
15
|
+
"ide_integration": true,
|
|
16
|
+
"issue_categorization": "labels",
|
|
17
|
+
"_copy_without_render": [
|
|
18
|
+
".github/workflows/build.yaml",
|
|
19
|
+
".github/workflows/test.yaml",
|
|
20
|
+
"docs/_templates/autosummary/**.rst"
|
|
21
|
+
],
|
|
22
|
+
"_exclude_on_template_update": [
|
|
23
|
+
"CHANGELOG.md",
|
|
24
|
+
"LICENSE",
|
|
25
|
+
"README.md",
|
|
26
|
+
"docs/api.md",
|
|
27
|
+
"docs/index.md",
|
|
28
|
+
"docs/notebooks/example.ipynb",
|
|
29
|
+
"docs/references.bib",
|
|
30
|
+
"docs/references.md",
|
|
31
|
+
"src/**",
|
|
32
|
+
"tests/**"
|
|
33
|
+
],
|
|
34
|
+
"_render_devdocs": false,
|
|
35
|
+
"_jinja2_env_vars": {
|
|
36
|
+
"lstrip_blocks": true,
|
|
37
|
+
"trim_blocks": true
|
|
38
|
+
},
|
|
39
|
+
"_template": "https://github.com/scverse/cookiecutter-scverse",
|
|
40
|
+
"_commit": "4e7f088d1b146b77460971ccfa5739099766ca52"
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"directory": null
|
|
44
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
root = true
|
|
2
|
+
|
|
3
|
+
[*]
|
|
4
|
+
indent_style = space
|
|
5
|
+
indent_size = 4
|
|
6
|
+
end_of_line = lf
|
|
7
|
+
charset = utf-8
|
|
8
|
+
trim_trailing_whitespace = true
|
|
9
|
+
insert_final_newline = true
|
|
10
|
+
|
|
11
|
+
[{*.{yml,yaml,toml},.cruft.json}]
|
|
12
|
+
indent_size = 2
|
|
13
|
+
|
|
14
|
+
[Makefile]
|
|
15
|
+
indent_style = tab
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
name: Bug report
|
|
2
|
+
description: Report something that is broken or incorrect
|
|
3
|
+
labels: bug
|
|
4
|
+
body:
|
|
5
|
+
- type: markdown
|
|
6
|
+
attributes:
|
|
7
|
+
value: |
|
|
8
|
+
**Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
|
|
9
|
+
detailing how to provide the necessary information for us to reproduce your bug. In brief:
|
|
10
|
+
* Please provide exact steps how to reproduce the bug in a clean Python environment.
|
|
11
|
+
* In case it's not clear what's causing this bug, please provide the data or the data generation procedure.
|
|
12
|
+
* Replicate problems on public datasets or share data subsets when full sharing isn't possible.
|
|
13
|
+
|
|
14
|
+
- type: textarea
|
|
15
|
+
id: report
|
|
16
|
+
attributes:
|
|
17
|
+
label: Report
|
|
18
|
+
description: A clear and concise description of what the bug is.
|
|
19
|
+
validations:
|
|
20
|
+
required: true
|
|
21
|
+
|
|
22
|
+
- type: textarea
|
|
23
|
+
id: versions
|
|
24
|
+
attributes:
|
|
25
|
+
label: Versions
|
|
26
|
+
description: |
|
|
27
|
+
Which version of packages.
|
|
28
|
+
|
|
29
|
+
Please install `session-info2`, run the following command in a notebook,
|
|
30
|
+
click the “Copy as Markdown” button, then paste the results into the text box below.
|
|
31
|
+
|
|
32
|
+
```python
|
|
33
|
+
In[1]: import session_info2; session_info2.session_info(dependencies=True)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Alternatively, run this in a console:
|
|
37
|
+
|
|
38
|
+
```python
|
|
39
|
+
>>> import session_info2; print(session_info2.session_info(dependencies=True)._repr_mimebundle_()["text/markdown"])
|
|
40
|
+
```
|
|
41
|
+
render: python
|
|
42
|
+
placeholder: |
|
|
43
|
+
anndata 0.11.3
|
|
44
|
+
---- ----
|
|
45
|
+
charset-normalizer 3.4.1
|
|
46
|
+
coverage 7.7.0
|
|
47
|
+
psutil 7.0.0
|
|
48
|
+
dask 2024.7.1
|
|
49
|
+
jaraco.context 5.3.0
|
|
50
|
+
numcodecs 0.15.1
|
|
51
|
+
jaraco.functools 4.0.1
|
|
52
|
+
Jinja2 3.1.6
|
|
53
|
+
sphinxcontrib-jsmath 1.0.1
|
|
54
|
+
sphinxcontrib-htmlhelp 2.1.0
|
|
55
|
+
toolz 1.0.0
|
|
56
|
+
session-info2 0.1.2
|
|
57
|
+
PyYAML 6.0.2
|
|
58
|
+
llvmlite 0.44.0
|
|
59
|
+
scipy 1.15.2
|
|
60
|
+
pandas 2.2.3
|
|
61
|
+
sphinxcontrib-devhelp 2.0.0
|
|
62
|
+
h5py 3.13.0
|
|
63
|
+
tblib 3.0.0
|
|
64
|
+
setuptools-scm 8.2.0
|
|
65
|
+
more-itertools 10.3.0
|
|
66
|
+
msgpack 1.1.0
|
|
67
|
+
sparse 0.15.5
|
|
68
|
+
wrapt 1.17.2
|
|
69
|
+
jaraco.collections 5.1.0
|
|
70
|
+
numba 0.61.0
|
|
71
|
+
pyarrow 19.0.1
|
|
72
|
+
pytz 2025.1
|
|
73
|
+
MarkupSafe 3.0.2
|
|
74
|
+
crc32c 2.7.1
|
|
75
|
+
sphinxcontrib-qthelp 2.0.0
|
|
76
|
+
sphinxcontrib-serializinghtml 2.0.0
|
|
77
|
+
zarr 2.18.4
|
|
78
|
+
asciitree 0.3.3
|
|
79
|
+
six 1.17.0
|
|
80
|
+
sphinxcontrib-applehelp 2.0.0
|
|
81
|
+
numpy 2.1.3
|
|
82
|
+
cloudpickle 3.1.1
|
|
83
|
+
sphinxcontrib-bibtex 2.6.3
|
|
84
|
+
natsort 8.4.0
|
|
85
|
+
jaraco.text 3.12.1
|
|
86
|
+
setuptools 76.1.0
|
|
87
|
+
Deprecated 1.2.18
|
|
88
|
+
packaging 24.2
|
|
89
|
+
python-dateutil 2.9.0.post0
|
|
90
|
+
---- ----
|
|
91
|
+
Python 3.13.2 | packaged by conda-forge | (main, Feb 17 2025, 14:10:22) [GCC 13.3.0]
|
|
92
|
+
OS Linux-6.11.0-109019-tuxedo-x86_64-with-glibc2.39
|
|
93
|
+
Updated 2025-03-18 15:47
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
name: Feature request
|
|
2
|
+
description: Propose a new feature for acumen
|
|
3
|
+
labels: enhancement
|
|
4
|
+
body:
|
|
5
|
+
- type: textarea
|
|
6
|
+
id: description
|
|
7
|
+
attributes:
|
|
8
|
+
label: Description of feature
|
|
9
|
+
description: Please describe your suggestion for a new feature. It might help to describe a problem or use case, plus any alternatives that you have considered.
|
|
10
|
+
validations:
|
|
11
|
+
required: true
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Check Build
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
|
|
9
|
+
concurrency:
|
|
10
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
11
|
+
cancel-in-progress: true
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
package:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v6
|
|
18
|
+
with:
|
|
19
|
+
filter: blob:none
|
|
20
|
+
fetch-depth: 0
|
|
21
|
+
- name: Install uv
|
|
22
|
+
uses: astral-sh/setup-uv@v7
|
|
23
|
+
- name: Build package
|
|
24
|
+
run: uv build
|
|
25
|
+
- name: Check package
|
|
26
|
+
run: uvx twine check --strict dist/*.whl
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
|
|
7
|
+
# Use "trusted publishing", see https://docs.pypi.org/trusted-publishers/
|
|
8
|
+
jobs:
|
|
9
|
+
release:
|
|
10
|
+
name: Upload release to PyPI
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
environment:
|
|
13
|
+
name: pypi
|
|
14
|
+
url: https://pypi.org/p/acumen
|
|
15
|
+
permissions:
|
|
16
|
+
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
|
|
17
|
+
steps:
|
|
18
|
+
- uses: actions/checkout@v6
|
|
19
|
+
with:
|
|
20
|
+
filter: blob:none
|
|
21
|
+
fetch-depth: 0
|
|
22
|
+
- name: Install uv
|
|
23
|
+
uses: astral-sh/setup-uv@v7
|
|
24
|
+
- name: Build package
|
|
25
|
+
run: uv build
|
|
26
|
+
- name: Publish package distributions to PyPI
|
|
27
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
name: Test
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
schedule:
|
|
9
|
+
- cron: "0 5 1,15 * *"
|
|
10
|
+
|
|
11
|
+
concurrency:
|
|
12
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
13
|
+
cancel-in-progress: true
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
# Get the test environment from hatch as defined in pyproject.toml.
|
|
17
|
+
# This ensures that the pyproject.toml is the single point of truth for test definitions and the same tests are
|
|
18
|
+
# run locally and on continuous integration.
|
|
19
|
+
# Check [[tool.hatch.envs.hatch-test.matrix]] in pyproject.toml and https://hatch.pypa.io/latest/environment/ for
|
|
20
|
+
# more details.
|
|
21
|
+
get-environments:
|
|
22
|
+
runs-on: ubuntu-slim
|
|
23
|
+
outputs:
|
|
24
|
+
envs: ${{ steps.get-envs.outputs.envs }}
|
|
25
|
+
steps:
|
|
26
|
+
- uses: actions/checkout@v6
|
|
27
|
+
with:
|
|
28
|
+
filter: blob:none
|
|
29
|
+
fetch-depth: 0
|
|
30
|
+
- name: Install uv
|
|
31
|
+
uses: astral-sh/setup-uv@v7
|
|
32
|
+
- name: Get test environments
|
|
33
|
+
id: get-envs
|
|
34
|
+
run: |
|
|
35
|
+
ENVS_JSON=$(uvx hatch env show --json | jq -c 'to_entries
|
|
36
|
+
| map(
|
|
37
|
+
select(.key | startswith("hatch-test"))
|
|
38
|
+
| {
|
|
39
|
+
name: .key,
|
|
40
|
+
label: (if (.key | contains("pre")) then .key + " (PRE-RELEASE DEPENDENCIES)" else .key end),
|
|
41
|
+
python: .value.python
|
|
42
|
+
}
|
|
43
|
+
)')
|
|
44
|
+
echo "envs=${ENVS_JSON}" | tee $GITHUB_OUTPUT
|
|
45
|
+
|
|
46
|
+
# Run tests through hatch. Spawns a separate runner for each environment defined in the hatch matrix obtained above.
|
|
47
|
+
test:
|
|
48
|
+
needs: get-environments
|
|
49
|
+
permissions:
|
|
50
|
+
id-token: write # for codecov OIDC
|
|
51
|
+
contents: read
|
|
52
|
+
|
|
53
|
+
strategy:
|
|
54
|
+
fail-fast: false
|
|
55
|
+
matrix:
|
|
56
|
+
os: [ubuntu-latest]
|
|
57
|
+
env: ${{ fromJSON(needs.get-environments.outputs.envs) }}
|
|
58
|
+
|
|
59
|
+
name: ${{ matrix.env.label }}
|
|
60
|
+
runs-on: ${{ matrix.os }}
|
|
61
|
+
continue-on-error: ${{ contains(matrix.env.name, 'pre') }} # make "all-green" pass even if pre-release job fails
|
|
62
|
+
|
|
63
|
+
steps:
|
|
64
|
+
- uses: actions/checkout@v6
|
|
65
|
+
with:
|
|
66
|
+
filter: blob:none
|
|
67
|
+
fetch-depth: 0
|
|
68
|
+
- name: Install uv
|
|
69
|
+
uses: astral-sh/setup-uv@v7
|
|
70
|
+
with:
|
|
71
|
+
python-version: ${{ matrix.env.python }}
|
|
72
|
+
- name: create hatch environment
|
|
73
|
+
run: uvx hatch env create ${{ matrix.env.name }}
|
|
74
|
+
- name: list all all installed package versions
|
|
75
|
+
run: uvx hatch run ${{ matrix.env.name }}:uv pip list
|
|
76
|
+
- name: run tests using hatch
|
|
77
|
+
env:
|
|
78
|
+
MPLBACKEND: agg
|
|
79
|
+
PLATFORM: ${{ matrix.os }}
|
|
80
|
+
DISPLAY: :42
|
|
81
|
+
run: uvx hatch run ${{ matrix.env.name }}:run-cov -v --color=yes -n auto
|
|
82
|
+
- name: generate coverage report
|
|
83
|
+
run: |
|
|
84
|
+
# See https://coverage.readthedocs.io/page/config.html#run-patch
|
|
85
|
+
test -f .coverage || uvx hatch run ${{ matrix.env.name }}:cov-combine
|
|
86
|
+
uvx hatch run ${{ matrix.env.name }}:cov-report # report visibly
|
|
87
|
+
uvx hatch run ${{ matrix.env.name }}:coverage xml # create report for upload
|
|
88
|
+
- name: Upload coverage
|
|
89
|
+
uses: codecov/codecov-action@v6
|
|
90
|
+
with:
|
|
91
|
+
# TODO: set back to true once scverse/acumen is onboarded on Codecov
|
|
92
|
+
fail_ci_if_error: false
|
|
93
|
+
use_oidc: true
|
|
94
|
+
|
|
95
|
+
# Check that all tests defined above pass. This makes it easy to set a single "required" test in branch
|
|
96
|
+
# protection instead of having to update it frequently. See https://github.com/re-actors/alls-green#why.
|
|
97
|
+
check:
|
|
98
|
+
name: Tests pass in all hatch environments
|
|
99
|
+
if: always()
|
|
100
|
+
needs:
|
|
101
|
+
- get-environments
|
|
102
|
+
- test
|
|
103
|
+
runs-on: ubuntu-latest
|
|
104
|
+
steps:
|
|
105
|
+
- uses: re-actors/alls-green@release/v1
|
|
106
|
+
with:
|
|
107
|
+
jobs: ${{ toJSON(needs) }}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Temp files
|
|
2
|
+
.DS_Store
|
|
3
|
+
*~
|
|
4
|
+
buck-out/
|
|
5
|
+
|
|
6
|
+
# Compiled files
|
|
7
|
+
.venv/
|
|
8
|
+
__pycache__/
|
|
9
|
+
.*cache/
|
|
10
|
+
|
|
11
|
+
# Distribution / packaging
|
|
12
|
+
/dist/
|
|
13
|
+
|
|
14
|
+
# Tests and coverage
|
|
15
|
+
/data/
|
|
16
|
+
/node_modules/
|
|
17
|
+
/.coverage*
|
|
18
|
+
|
|
19
|
+
# docs
|
|
20
|
+
/docs/generated/
|
|
21
|
+
/docs/_build/
|
|
22
|
+
|
|
23
|
+
# Benchmark output: transcripts and metrics, regenerated by `acumen bench`.
|
|
24
|
+
# skills/ is NOT ignored — a drafted skill is a versioned, immutable artifact.
|
|
25
|
+
runs/
|
|
26
|
+
|
|
27
|
+
# Worked examples (config, tasks, skills, runs, reports) are kept out of the repo.
|
|
28
|
+
examples/
|
|
29
|
+
|
|
30
|
+
# Generated reports.
|
|
31
|
+
report.html
|
|
32
|
+
report.csv
|
|
33
|
+
|
|
34
|
+
*ipynb*
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
fail_fast: false
|
|
2
|
+
default_language_version:
|
|
3
|
+
python: python3
|
|
4
|
+
default_stages:
|
|
5
|
+
- pre-commit
|
|
6
|
+
- pre-push
|
|
7
|
+
minimum_pre_commit_version: 2.16.0
|
|
8
|
+
repos:
|
|
9
|
+
- repo: https://github.com/biomejs/pre-commit
|
|
10
|
+
rev: v2.5.3
|
|
11
|
+
hooks:
|
|
12
|
+
- id: biome-format
|
|
13
|
+
exclude: ^\.cruft\.json$ # inconsistent indentation with cruft - file never to be modified manually.
|
|
14
|
+
- repo: https://github.com/tox-dev/pyproject-fmt
|
|
15
|
+
rev: v2.25.3
|
|
16
|
+
hooks:
|
|
17
|
+
- id: pyproject-fmt
|
|
18
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
19
|
+
rev: v0.15.21
|
|
20
|
+
hooks:
|
|
21
|
+
- id: ruff-check
|
|
22
|
+
types_or: [python, pyi, jupyter]
|
|
23
|
+
args: [--fix, --exit-non-zero-on-fix]
|
|
24
|
+
- id: ruff-format
|
|
25
|
+
types_or: [python, pyi, jupyter]
|
|
26
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
27
|
+
rev: v6.0.0
|
|
28
|
+
hooks:
|
|
29
|
+
- id: detect-private-key
|
|
30
|
+
- id: check-ast
|
|
31
|
+
- id: end-of-file-fixer
|
|
32
|
+
- id: mixed-line-ending
|
|
33
|
+
args: [--fix=lf]
|
|
34
|
+
- id: trailing-whitespace
|
|
35
|
+
- id: check-case-conflict
|
|
36
|
+
# Check that there are no merge conflicts (could be generated by template sync)
|
|
37
|
+
- id: check-merge-conflict
|
|
38
|
+
args: [--assume-in-merge]
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# https://docs.readthedocs.io/page/config-file/v2.html
|
|
2
|
+
version: 2
|
|
3
|
+
build:
|
|
4
|
+
os: ubuntu-24.04
|
|
5
|
+
tools:
|
|
6
|
+
python: "3.14"
|
|
7
|
+
nodejs: latest
|
|
8
|
+
jobs:
|
|
9
|
+
create_environment:
|
|
10
|
+
- asdf plugin add uv
|
|
11
|
+
- asdf install uv latest
|
|
12
|
+
- asdf global uv latest
|
|
13
|
+
build:
|
|
14
|
+
html:
|
|
15
|
+
- uvx hatch run docs:build
|
|
16
|
+
- mv docs/_build $READTHEDOCS_OUTPUT
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"recommendations": [
|
|
3
|
+
// GitHub integration
|
|
4
|
+
"github.vscode-github-actions",
|
|
5
|
+
"github.vscode-pull-request-github",
|
|
6
|
+
// Language support
|
|
7
|
+
"ms-python.python",
|
|
8
|
+
"ms-python.vscode-pylance",
|
|
9
|
+
"ms-toolsai.jupyter",
|
|
10
|
+
"tamasfe.even-better-toml",
|
|
11
|
+
// Dependency management
|
|
12
|
+
"ninoseki.vscode-mogami",
|
|
13
|
+
// Linting and formatting
|
|
14
|
+
"editorconfig.editorconfig",
|
|
15
|
+
"charliermarsh.ruff",
|
|
16
|
+
"biomejs.biome",
|
|
17
|
+
],
|
|
18
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
// Use IntelliSense to learn about possible attributes.
|
|
3
|
+
// Hover to view descriptions of existing attributes.
|
|
4
|
+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
|
5
|
+
"version": "0.2.0",
|
|
6
|
+
"configurations": [
|
|
7
|
+
{
|
|
8
|
+
"name": "Python: Build Documentation",
|
|
9
|
+
"type": "debugpy",
|
|
10
|
+
"request": "launch",
|
|
11
|
+
"module": "sphinx",
|
|
12
|
+
"args": ["-M", "html", ".", "_build"],
|
|
13
|
+
"cwd": "${workspaceFolder}/docs",
|
|
14
|
+
"console": "internalConsole",
|
|
15
|
+
"justMyCode": false,
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"name": "Python: Debug Test",
|
|
19
|
+
"type": "debugpy",
|
|
20
|
+
"request": "launch",
|
|
21
|
+
"program": "${file}",
|
|
22
|
+
"purpose": ["debug-test"],
|
|
23
|
+
"console": "internalConsole",
|
|
24
|
+
"justMyCode": false,
|
|
25
|
+
"env": {
|
|
26
|
+
"PYTEST_ADDOPTS": "--color=yes",
|
|
27
|
+
},
|
|
28
|
+
"presentation": {
|
|
29
|
+
"hidden": true,
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
],
|
|
33
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"[python][json][jsonc]": {
|
|
3
|
+
"editor.formatOnSave": true,
|
|
4
|
+
},
|
|
5
|
+
"[python]": {
|
|
6
|
+
"editor.defaultFormatter": "charliermarsh.ruff",
|
|
7
|
+
"editor.codeActionsOnSave": {
|
|
8
|
+
"source.fixAll": "always",
|
|
9
|
+
"source.organizeImports": "always",
|
|
10
|
+
},
|
|
11
|
+
},
|
|
12
|
+
"[json][jsonc]": {
|
|
13
|
+
"editor.defaultFormatter": "biomejs.biome",
|
|
14
|
+
},
|
|
15
|
+
"python.analysis.typeCheckingMode": "basic",
|
|
16
|
+
"python.testing.pytestEnabled": true,
|
|
17
|
+
"python.testing.pytestArgs": ["-vv", "--color=yes"],
|
|
18
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog][],
|
|
6
|
+
and this project adheres to [Semantic Versioning][].
|
|
7
|
+
|
|
8
|
+
[keep a changelog]: https://keepachangelog.com/
|
|
9
|
+
[semantic versioning]: https://semver.org/
|
|
10
|
+
|
|
11
|
+
## [0.0.1dev]
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, Pau Badia i Mompel
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|