Skip to content

Commit 0ea512c

Browse files
authored
Update template to v0.3.0 (#186)
Co-authored-by: scverse-bot <None>
1 parent 74afb01 commit 0ea512c

17 files changed

+396
-500
lines changed

.bumpversion.cfg

Lines changed: 0 additions & 8 deletions
This file was deleted.

.codecov.yaml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Based on pydata/xarray
22
codecov:
3-
require_ci_to_pass: no
3+
require_ci_to_pass: no
44

55
coverage:
6-
status:
7-
project:
8-
default:
9-
# Require 1% coverage, i.e., always succeed
10-
target: 1
11-
patch: false
12-
changes: false
6+
status:
7+
project:
8+
default:
9+
# Require 1% coverage, i.e., always succeed
10+
target: 1
11+
patch: false
12+
changes: false
1313

1414
comment:
15-
layout: diff, flags, files
16-
behavior: once
17-
require_base: no
15+
layout: diff, flags, files
16+
behavior: once
17+
require_base: no

.cruft.json

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
11
{
2-
"template": "https://github.com/scverse/cookiecutter-scverse",
3-
"commit": "1929d97848fd6a62fe2916dec21d6c3de99cd0a2",
4-
"checkout": "v0.2.9",
5-
"context": {
6-
"cookiecutter": {
7-
"project_name": "spatialdata-plot",
8-
"package_name": "spatialdata_plot",
9-
"project_description": "A very interesting piece of code",
10-
"author_full_name": "scverse",
11-
"author_email": "scverse",
12-
"github_user": "scverse",
13-
"project_repo": "https://github.com/scverse/spatialdata-plot",
14-
"license": "BSD 3-Clause License",
15-
"_copy_without_render": [
16-
".github/workflows/**.yaml",
17-
"docs/_templates/autosummary/**.rst"
18-
],
19-
"_template": "https://github.com/scverse/cookiecutter-scverse"
20-
}
21-
},
22-
"directory": null
2+
"template": "https://github.com/scverse/cookiecutter-scverse",
3+
"commit": "8e96abb5c3e2d5078c44713958da672711cf2a48",
4+
"checkout": "v0.3.0",
5+
"context": {
6+
"cookiecutter": {
7+
"project_name": "spatialdata-plot",
8+
"package_name": "spatialdata_plot",
9+
"project_description": "A very interesting piece of code",
10+
"author_full_name": "scverse",
11+
"author_email": "scverse",
12+
"github_user": "scverse",
13+
"project_repo": "https://github.com/scverse/spatialdata-plot",
14+
"license": "BSD 3-Clause License",
15+
"_copy_without_render": [
16+
".github/workflows/**.yaml",
17+
"docs/_templates/autosummary/**.rst"
18+
],
19+
"_render_devdocs": false,
20+
"_jinja2_env_vars": {
21+
"lstrip_blocks": true,
22+
"trim_blocks": true
23+
},
24+
"_template": "https://github.com/scverse/cookiecutter-scverse"
25+
}
26+
},
27+
"directory": null
2328
}

.editorconfig

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,11 @@ 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]
15+
indent_size = 2
16+
1117
[Makefile]
1218
indent_style = tab

.github/workflows/build.yaml.rej

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
diff a/.github/workflows/build.yaml b/.github/workflows/build.yaml (rejected hunks)
2+
@@ -1,29 +1,29 @@
3+
name: Check Build
4+
5+
on:
6+
- push:
7+
- branches: [main]
8+
- pull_request:
9+
- branches: [main]
10+
+ push:
11+
+ branches: [main]
12+
+ pull_request:
13+
+ branches: [main]
14+
15+
concurrency:
16+
- group: ${{ github.workflow }}-${{ github.ref }}
17+
- cancel-in-progress: true
18+
+ group: ${{ github.workflow }}-${{ github.ref }}
19+
+ cancel-in-progress: true
20+
21+
jobs:
22+
- package:
23+
- runs-on: ubuntu-latest
24+
- steps:
25+
- - uses: actions/checkout@v3
26+
- - name: Set up Python 3.10
27+
- uses: actions/setup-python@v4
28+
- with:
29+
- python-version: "3.10"
30+
- cache: "pip"
31+
- cache-dependency-path: "**/pyproject.toml"
32+
- - name: Install build dependencies
33+
- run: python -m pip install --upgrade pip wheel twine build
34+
- - name: Build package
35+
- run: python -m build
36+
- - name: Check package
37+
- run: twine check --strict dist/*.whl
38+
+ package:
39+
+ runs-on: ubuntu-latest
40+
+ steps:
41+
+ - uses: actions/checkout@v3
42+
+ - name: Set up Python 3.10
43+
+ uses: actions/setup-python@v4
44+
+ with:
45+
+ python-version: "3.10"
46+
+ cache: "pip"
47+
+ cache-dependency-path: "**/pyproject.toml"
48+
+ - name: Install build dependencies
49+
+ run: python -m pip install --upgrade pip wheel twine build
50+
+ - name: Build package
51+
+ run: python -m build
52+
+ - name: Check package
53+
+ run: twine check --strict dist/*.whl

.github/workflows/release.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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/{{ cookiecutter.package_name }}
15+
permissions:
16+
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
17+
steps:
18+
- uses: actions/checkout@v4
19+
with:
20+
filter: blob:none
21+
fetch-depth: 0
22+
- uses: actions/setup-python@v4
23+
with:
24+
python-version: "3.x"
25+
cache: "pip"
26+
- run: pip install build
27+
- run: python -m build
28+
- name: Publish package distributions to PyPI
29+
uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml.rej

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
diff a/.pre-commit-config.yaml b/.pre-commit-config.yaml (rejected hunks)
2+
@@ -1,50 +1,53 @@
3+
fail_fast: false
4+
default_language_version:
5+
- python: python3
6+
+ python: python3
7+
default_stages:
8+
- - commit
9+
- - push
10+
+ - commit
11+
+ - push
12+
minimum_pre_commit_version: 2.16.0
13+
repos:
14+
- - repo: https://github.com/psf/black
15+
- rev: "23.11.0"
16+
- hooks:
17+
- - id: black
18+
- - repo: https://github.com/asottile/blacken-docs
19+
- rev: 1.16.0
20+
- hooks:
21+
- - id: blacken-docs
22+
- - repo: https://github.com/pre-commit/mirrors-prettier
23+
- rev: v3.1.0
24+
- hooks:
25+
- - id: prettier
26+
- # Newer versions of node don't work on systems that have an older version of GLIBC
27+
- # (in particular Ubuntu 18.04 and Centos 7)
28+
- # EOL of Centos 7 is in 2024-06, we can probably get rid of this then.
29+
- # See https://github.com/scverse/cookiecutter-scverse/issues/143 and
30+
- # https://github.com/jupyterlab/jupyterlab/issues/12675
31+
- language_version: "17.9.1"
32+
- - repo: https://github.com/charliermarsh/ruff-pre-commit
33+
- rev: v0.1.6
34+
- hooks:
35+
- - id: ruff
36+
- args: [--fix, --exit-non-zero-on-fix]
37+
- - repo: https://github.com/pre-commit/pre-commit-hooks
38+
- rev: v4.5.0
39+
- hooks:
40+
- - id: detect-private-key
41+
- - id: check-ast
42+
- - id: end-of-file-fixer
43+
- - id: mixed-line-ending
44+
- args: [--fix=lf]
45+
- - id: trailing-whitespace
46+
- - id: check-case-conflict
47+
- - repo: local
48+
- hooks:
49+
- - id: forbid-to-commit
50+
- name: Don't commit rej files
51+
- entry: |
52+
- Cannot commit .rej files. These indicate merge conflicts that arise during automated template updates.
53+
- Fix the merge conflicts manually and remove the .rej files.
54+
- language: fail
55+
- files: '.*\.rej$'
56+
+ - repo: https://github.com/psf/black
57+
+ rev: "23.11.0"
58+
+ hooks:
59+
+ - id: black
60+
+ - repo: https://github.com/asottile/blacken-docs
61+
+ rev: 1.16.0
62+
+ hooks:
63+
+ - id: blacken-docs
64+
+ - repo: https://github.com/pre-commit/mirrors-prettier
65+
+ rev: v3.1.0
66+
+ hooks:
67+
+ - id: prettier
68+
+ # Newer versions of node don't work on systems that have an older version of GLIBC
69+
+ # (in particular Ubuntu 18.04 and Centos 7)
70+
+ # EOL of Centos 7 is in 2024-06, we can probably get rid of this then.
71+
+ # See https://github.com/scverse/cookiecutter-scverse/issues/143 and
72+
+ # https://github.com/jupyterlab/jupyterlab/issues/12675
73+
+ language_version: "17.9.1"
74+
+ - repo: https://github.com/astral-sh/ruff-pre-commit
75+
+ rev: v0.1.6
76+
+ hooks:
77+
+ - id: ruff
78+
+ args: [--fix, --exit-non-zero-on-fix]
79+
+ - repo: https://github.com/pre-commit/pre-commit-hooks
80+
+ rev: v4.5.0
81+
+ hooks:
82+
+ - id: detect-private-key
83+
+ - id: check-ast
84+
+ - id: end-of-file-fixer
85+
+ - id: mixed-line-ending
86+
+ args: [--fix=lf]
87+
+ - id: trailing-whitespace
88+
+ - id: check-case-conflict
89+
+ # Check that there are no merge conflicts (could be generated by template sync)
90+
+ - id: check-merge-conflict
91+
+ args: [--assume-in-merge]
92+
+ - repo: local
93+
+ hooks:
94+
+ - id: forbid-to-commit
95+
+ name: Don't commit rej files
96+
+ entry: |
97+
+ Cannot commit .rej files. These indicate merge conflicts that arise during automated template updates.
98+
+ Fix the merge conflicts manually and remove the .rej files.
99+
+ language: fail
100+
+ files: '.*\.rej$'

.readthedocs.yaml.rej

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
diff a/.readthedocs.yaml b/.readthedocs.yaml (rejected hunks)
2+
@@ -1,16 +1,16 @@
3+
# https://docs.readthedocs.io/en/stable/config-file/v2.html
4+
version: 2
5+
build:
6+
- os: ubuntu-20.04
7+
- tools:
8+
- python: "3.10"
9+
+ os: ubuntu-20.04
10+
+ tools:
11+
+ python: "3.10"
12+
sphinx:
13+
- configuration: docs/conf.py
14+
- # disable this for more lenient docs builds
15+
- fail_on_warning: true
16+
+ configuration: docs/conf.py
17+
+ # disable this for more lenient docs builds
18+
+ fail_on_warning: true
19+
python:
20+
- install:
21+
- - method: pip
22+
- path: .
23+
- extra_requirements:
24+
- - doc
25+
+ install:
26+
+ - method: pip
27+
+ path: .
28+
+ extra_requirements:
29+
+ - doc

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For more information on the `spatialdata-plot` library, please refer to the [doc
3131

3232
## Installation
3333

34-
You need to have Python 3.8 or newer installed on your system. If you don't have
34+
You need to have Python 3.9 or newer installed on your system. If you don't have
3535
Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
3636

3737
There are several alternative options to install spatialdata-plot:

docs/_static/css/custom.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/* Reduce the font size in data frames - See https://github.com/scverse/cookiecutter-scverse/issues/193 */
2+
div.cell_output table.dataframe {
3+
font-size: 0.8em;
4+
}

docs/conf.py.rej

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
diff a/docs/conf.py b/docs/conf.py (rejected hunks)
2+
@@ -57,6 +57,7 @@ extensions = [
3+
"sphinx_autodoc_typehints",
4+
"sphinx.ext.mathjax",
5+
"IPython.sphinxext.ipython_console_highlighting",
6+
+ "sphinxext.opengraph",
7+
*[p.stem for p in (HERE / "extensions").glob("*.py")],
8+
]
9+
10+
@@ -108,12 +109,15 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
11+
#
12+
html_theme = "sphinx_book_theme"
13+
html_static_path = ["_static"]
14+
+html_css_files = ["css/custom.css"]
15+
+
16+
html_title = project_name
17+
18+
html_theme_options = {
19+
"repository_url": repository_url,
20+
"use_repository_button": True,
21+
"path_to_docs": "docs/",
22+
+ "navigation_with_keys": False,
23+
}
24+
25+
pygments_style = "default"
26+
@@ -123,18 +127,3 @@ nitpick_ignore = [
27+
# you can add an exception to this list.
28+
# ("py:class", "igraph.Graph"),
29+
]
30+
-
31+
-
32+
-def setup(app):
33+
- """App setup hook."""
34+
- app.add_config_value(
35+
- "recommonmark_config",
36+
- {
37+
- "auto_toc_tree_section": "Contents",
38+
- "enable_auto_toc_tree": True,
39+
- "enable_math": True,
40+
- "enable_inline_math": False,
41+
- "enable_eval_rst": True,
42+
- },
43+
- True,
44+
- )

0 commit comments

Comments
 (0)