-
Notifications
You must be signed in to change notification settings - Fork 93
Adopt the scverse cookiecutter template #1197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Zethson
wants to merge
29
commits into
main
Choose a base branch
from
adopt-scverse-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
c5cae16
build: adopt the scverse cookiecutter template
Zethson cf8f57d
style: apply the template's ruff and biome formatting
Zethson de410b7
docs: fix the two docstrings and the missing reference that break a -…
Zethson ef46c39
refactor: stop suppressing mypy errors and start fixing them
Zethson 493bd24
refactor: type the zarr io layer
Zethson a5bdd93
refactor: type the bins rasterization
Zethson 5857178
refactor: type the raster and label models
Zethson 14af12f
refactor: type the model utilities
Zethson 14972d5
fix: make the table instance-key dtype check actually run
Zethson aeae643
refactor: build typed element dicts instead of splatting a dict of dicts
Zethson 66ef94a
refactor: type element dispatch in SpatialData
Zethson d578a45
refactor: finish typing SpatialData
Zethson 3d901e0
refactor: type the relational queries
Zethson a17303b
refactor: make the join return types admit the empty result
Zethson ab0b9f1
refactor: type get_values and the join validation
Zethson 77a6707
refactor: type get_values and the join validation
Zethson 88fcee4
refactor: overload RasterSchema.parse on scale_factors
Zethson 06795b5
refactor: type the rasterization entry points
Zethson 3ba5e6d
refactor: type the spatial queries and the tile dataset
Zethson b7f9dc1
refactor: type the vectorization
Zethson 7e08127
fix: only compute the zonal statistics when they are dask backed
Zethson 102367e
fix: only compute the zonal statistics when they are dask backed
Zethson 8fbf7e3
fix: repair two unreachable zarr store branches
Zethson a84b081
refactor: type the shared utilities and the mapping helpers
Zethson 95a6574
refactor: type the transform, deepcopy and concatenate paths
Zethson 3e91e0b
refactor: type the transformation graph, centroids and extent helpers
Zethson 5a17079
fix: write a shapes index of strings through a variable-length string…
Zethson db62c0d
refactor: finish typing the package
Zethson 56ffafe
docs: cut the boilerplate comments and unwrap the prose
Zethson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Based on pydata/xarray | ||
| codecov: | ||
| require_ci_to_pass: no | ||
|
|
||
| coverage: | ||
| status: | ||
| project: | ||
| default: | ||
| # Require 1% coverage, i.e., always succeed | ||
| target: 1 | ||
| patch: false | ||
| changes: false | ||
|
|
||
| comment: | ||
| layout: diff, flags, files | ||
| behavior: once | ||
| require_base: no |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| { | ||
| "template": "https://github.com/scverse/cookiecutter-scverse", | ||
| "commit": "eb4523fde2e18bcfc121ff2cd722c9037ff8b910", | ||
| "checkout": null, | ||
| "context": { | ||
| "cookiecutter": { | ||
| "project_name": "spatialdata", | ||
| "package_name": "spatialdata", | ||
| "project_description": "Spatial data format.", | ||
| "author_full_name": "scverse", | ||
| "author_email": "giov.pll@gmail.com", | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Luca or whose email? |
||
| "github_user": "scverse", | ||
| "github_repo": "spatialdata", | ||
| "license": "BSD 3-Clause License", | ||
| "ide_integration": true, | ||
| "issue_categorization": "labels", | ||
| "_copy_without_render": [ | ||
| ".github/workflows/build.yaml", | ||
| ".github/workflows/test.yaml", | ||
| "docs/_templates/autosummary/**.rst" | ||
| ], | ||
| "_exclude_on_template_update": [ | ||
| "CHANGELOG.md", | ||
| "LICENSE", | ||
| "README.md", | ||
| "docs/api.md", | ||
| "docs/index.md", | ||
| "docs/notebooks/example.ipynb", | ||
| "docs/references.bib", | ||
| "docs/references.md", | ||
| "src/**", | ||
| "tests/**" | ||
| ], | ||
| "_render_devdocs": false, | ||
| "_jinja2_env_vars": { | ||
| "lstrip_blocks": true, | ||
| "trim_blocks": true | ||
| }, | ||
| "_template": "https://github.com/scverse/cookiecutter-scverse", | ||
| "_commit": "eb4523fde2e18bcfc121ff2cd722c9037ff8b910" | ||
| } | ||
| }, | ||
| "directory": null | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| name: Bug report | ||
| description: Report something that is broken or incorrect | ||
| labels: bug | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| **Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) | ||
| detailing how to provide the necessary information for us to reproduce your bug. In brief: | ||
| * Please provide exact steps how to reproduce the bug in a clean Python environment. | ||
| * In case it's not clear what's causing this bug, please provide the data or the data generation procedure. | ||
| * Replicate problems on public datasets or share data subsets when full sharing isn't possible. | ||
|
|
||
| Generally, the easier it is for us to reproduce the issue, the faster we can work on it. If you can, please: | ||
|
|
||
| 1. Reproduce using the [`blobs` dataset](https://spatialdata.scverse.org/en/stable/api/datasets.html#spatialdata.datasets.blobs): | ||
|
|
||
| ```python | ||
| from spatialdata.datasets import blobs | ||
|
|
||
| sdata = blobs() | ||
| ``` | ||
|
|
||
| You can also use [`blobs_annotating_element`](https://spatialdata.scverse.org/en/stable/api/datasets.html#spatialdata.datasets.blobs_annotating_element) for more control: | ||
|
|
||
| ```python | ||
| from spatialdata.datasets import blobs_annotating_element | ||
|
|
||
| sdata = blobs_annotating_element("blobs_labels") | ||
| ``` | ||
|
|
||
| 2. If the above is not possible, reproduce using a public dataset and explain how we can download the data. | ||
| 3. If the data is private, consider sharing an anonymized version/subset via a [Zulip private message](https://scverse.zulipchat.com/#user/480560), or provide screenshots/GIFs showing the behavior. | ||
|
|
||
| Please report only one bug per issue. | ||
|
|
||
| - type: textarea | ||
| id: report | ||
| attributes: | ||
| label: Report | ||
| description: A clear and concise description of what the bug is. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: versions | ||
| attributes: | ||
| label: Versions | ||
| description: | | ||
| Which version of packages. | ||
|
|
||
| Please install `session-info2`, run the following command in a notebook, | ||
| click the “Copy as Markdown” button, then paste the results into the text box below. | ||
|
|
||
| ```python | ||
| In[1]: import session_info2; session_info2.session_info(dependencies=True) | ||
| ``` | ||
|
|
||
| Alternatively, run this in a console: | ||
|
|
||
| ```python | ||
| >>> import session_info2; print(session_info2.session_info(dependencies=True)._repr_mimebundle_()["text/markdown"]) | ||
| ``` | ||
| render: python | ||
| placeholder: | | ||
| anndata 0.11.3 | ||
| ---- ---- | ||
| charset-normalizer 3.4.1 | ||
| coverage 7.7.0 | ||
| psutil 7.0.0 | ||
| dask 2024.7.1 | ||
| jaraco.context 5.3.0 | ||
| numcodecs 0.15.1 | ||
| jaraco.functools 4.0.1 | ||
| Jinja2 3.1.6 | ||
| sphinxcontrib-jsmath 1.0.1 | ||
| sphinxcontrib-htmlhelp 2.1.0 | ||
| toolz 1.0.0 | ||
| session-info2 0.1.2 | ||
| PyYAML 6.0.2 | ||
| llvmlite 0.44.0 | ||
| scipy 1.15.2 | ||
| pandas 2.2.3 | ||
| sphinxcontrib-devhelp 2.0.0 | ||
| h5py 3.13.0 | ||
| tblib 3.0.0 | ||
| setuptools-scm 8.2.0 | ||
| more-itertools 10.3.0 | ||
| msgpack 1.1.0 | ||
| sparse 0.15.5 | ||
| wrapt 1.17.2 | ||
| jaraco.collections 5.1.0 | ||
| numba 0.61.0 | ||
| pyarrow 19.0.1 | ||
| pytz 2025.1 | ||
| MarkupSafe 3.0.2 | ||
| crc32c 2.7.1 | ||
| sphinxcontrib-qthelp 2.0.0 | ||
| sphinxcontrib-serializinghtml 2.0.0 | ||
| zarr 2.18.4 | ||
| asciitree 0.3.3 | ||
| six 1.17.0 | ||
| sphinxcontrib-applehelp 2.0.0 | ||
| numpy 2.1.3 | ||
| cloudpickle 3.1.1 | ||
| sphinxcontrib-bibtex 2.6.3 | ||
| natsort 8.4.0 | ||
| jaraco.text 3.12.1 | ||
| setuptools 76.1.0 | ||
| Deprecated 1.2.18 | ||
| packaging 24.2 | ||
| python-dateutil 2.9.0.post0 | ||
| ---- ---- | ||
| Python 3.13.2 | packaged by conda-forge | (main, Feb 17 2025, 14:10:22) [GCC 13.3.0] | ||
| OS Linux-6.11.0-109019-tuxedo-x86_64-with-glibc2.39 | ||
| Updated 2025-03-18 15:47 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Scverse Community Forum | ||
| url: https://discourse.scverse.org/ | ||
| about: If you have questions about “How to do X”, please ask them here. |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| name: Feature request | ||
| description: Propose a new feature for spatialdata | ||
| labels: enhancement | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description of feature | ||
| 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. | ||
| validations: | ||
| required: true |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: pre-commit | ||
| directory: / | ||
| schedule: | ||
| interval: weekly | ||
| cooldown: | ||
| default-days: 7 | ||
| groups: | ||
| pre-commit: | ||
| patterns: ["*"] | ||
| - package-ecosystem: github-actions | ||
| directory: / | ||
| schedule: | ||
| interval: weekly | ||
| cooldown: | ||
| default-days: 7 | ||
| groups: | ||
| actions-deps: | ||
| patterns: | ||
| - "*" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,29 @@ | ||
| changelog: | ||
| exclude: | ||
| labels: | ||
| - release-ignore | ||
| authors: | ||
| - pre-commit-ci | ||
| - pre-commit-ci[bot] | ||
| categories: | ||
| - title: Added | ||
| labels: | ||
| - "release-added" | ||
| - title: Changed | ||
| labels: | ||
| - "release-changed" | ||
| - title: Deprecated | ||
| labels: | ||
| - "release-deprecated" | ||
| - title: Removed | ||
| labels: | ||
| - "release-removed" | ||
| - title: Fixed | ||
| labels: | ||
| - "release-fixed" | ||
| - title: Security | ||
| labels: | ||
| - "release-security" | ||
| - title: Other Changes | ||
| labels: | ||
| - "*" | ||
| exclude: | ||
| labels: | ||
| - release-ignore | ||
| authors: | ||
| - pre-commit-ci | ||
| - pre-commit-ci[bot] | ||
| categories: | ||
| - title: Added | ||
| labels: | ||
| - "release-added" | ||
| - title: Changed | ||
| labels: | ||
| - "release-changed" | ||
| - title: Deprecated | ||
| labels: | ||
| - "release-deprecated" | ||
| - title: Removed | ||
| labels: | ||
| - "release-removed" | ||
| - title: Fixed | ||
| labels: | ||
| - "release-fixed" | ||
| - title: Security | ||
| labels: | ||
| - "release-security" | ||
| - title: Other Changes | ||
| labels: | ||
| - "*" |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should not be null but rather main or 0.8.0