Skip to content

Commit 5da843a

Browse files
timtreisclaude
andcommitted
Sync project scaffolding with cookiecutter-scverse v0.7.0 (phase 1)
Update config, issue templates, editor/IDE settings, and docs templates to match the scverse template v0.7.0. No source code or CI changes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 4fe68de commit 5da843a

12 files changed

Lines changed: 167 additions & 54 deletions

File tree

.cruft.json

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"template": "https://github.com/scverse/cookiecutter-scverse",
3-
"commit": "87a407a65408d75a949c0b54b19fd287475a56f8",
4-
"checkout": "v0.4.0",
3+
"commit": "6ff5b92b5d44ea6d8a88e47538475718d467db95",
4+
"checkout": "v0.7.0",
55
"context": {
66
"cookiecutter": {
77
"project_name": "spatialdata-plot",
@@ -10,19 +10,33 @@
1010
"author_full_name": "scverse",
1111
"author_email": "scverse",
1212
"github_user": "scverse",
13-
"project_repo": "https://github.com/scverse/spatialdata-plot",
13+
"github_repo": "spatialdata-plot",
1414
"license": "BSD 3-Clause License",
15+
"ide_integration": true,
1516
"_copy_without_render": [
1617
".github/workflows/build.yaml",
1718
".github/workflows/test.yaml",
1819
"docs/_templates/autosummary/**.rst"
1920
],
21+
"_exclude_on_template_update": [
22+
"CHANGELOG.md",
23+
"LICENSE",
24+
"README.md",
25+
"docs/api.md",
26+
"docs/index.md",
27+
"docs/notebooks/example.ipynb",
28+
"docs/references.bib",
29+
"docs/references.md",
30+
"src/**",
31+
"tests/**"
32+
],
2033
"_render_devdocs": false,
2134
"_jinja2_env_vars": {
2235
"lstrip_blocks": true,
2336
"trim_blocks": true
2437
},
25-
"_template": "https://github.com/scverse/cookiecutter-scverse"
38+
"_template": "https://github.com/scverse/cookiecutter-scverse",
39+
"_commit": "6ff5b92b5d44ea6d8a88e47538475718d467db95"
2640
}
2741
},
2842
"directory": null

.editorconfig

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@ charset = utf-8
88
trim_trailing_whitespace = true
99
insert_final_newline = true
1010

11-
[*.{yml,yaml}]
12-
indent_size = 2
13-
14-
[.cruft.json]
11+
[{*.{yml,yaml,toml},.cruft.json}]
1512
indent_size = 2
1613

1714
[Makefile]
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug report
2+
description: Report something that is broken or incorrect
3+
type: 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

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Scverse Community Forum
4+
url: https://discourse.scverse.org/
5+
about: If you have questions about "How to do X", please ask them here.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Feature request
2+
description: Propose a new feature for spatialdata-plot
3+
type: 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

.gitignore

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ buck-out/
66
# Compiled files
77
.venv/
88
__pycache__/
9-
.mypy_cache/
10-
.ruff_cache/
9+
.*cache/
1110
/node_modules
1211

1312
# Distribution / packaging
@@ -16,7 +15,6 @@ __pycache__/
1615
/*.egg-info/
1716

1817
# Tests and coverage
19-
/.pytest_cache/
2018
/.cache/
2119
/data/
2220
*failed-diff.png
@@ -27,11 +25,9 @@ __pycache__/
2725

2826
# IDEs
2927
/.idea/
30-
/.vscode/
3128

3229
format.sh
3330

34-
3531
# test
3632
tests/figures/
3733

.vscode/extensions.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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+
}

.vscode/launch.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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+
}

.vscode/settings.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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+
}

biome.jsonc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"$schema": "https://biomejs.dev/schemas/2.2.0/schema.json",
3+
"vcs": { "enabled": true, "clientKind": "git", "useIgnoreFile": true },
4+
"formatter": { "useEditorconfig": true },
5+
"overrides": [
6+
{
7+
"includes": ["./.vscode/*.json", "**/*.jsonc"],
8+
"json": {
9+
"formatter": { "trailingCommas": "all" },
10+
"parser": {
11+
"allowComments": true,
12+
"allowTrailingCommas": true,
13+
},
14+
},
15+
},
16+
],
17+
}

0 commit comments

Comments
 (0)