Skip to content
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

Migrate to pyproject.toml, ruff, add build CI #400

Merged
merged 26 commits into from
Jan 27, 2023
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 9 additions & 20 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,24 @@ ci:
autoupdate_schedule: quarterly

repos:
- repo: https://github.com/PyCQA/isort
rev: 5.11.4
- repo: https://github.com/charliermarsh/ruff-pre-commit
# Ruff version.
rev: 'v0.0.235'
hooks:
- id: isort
files: .+\.py$
- id: ruff
args: ["--fix"]

- repo: https://github.com/psf/black
rev: 22.12.0
hooks:
- id: black

- repo: https://github.com/PyCQA/flake8
rev: 6.0.0
hooks:
- id: flake8

- repo: https://github.com/rstcheck/rstcheck
rev: v6.1.1
hooks:
- id: rstcheck
additional_dependencies: [sphinx]
additional_dependencies: [sphinx, tomli]
args: ['--config', 'pyproject.toml']

- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
Expand All @@ -36,29 +33,21 @@ repos:
rev: 1.6.0
hooks:
- id: nbqa-black
- id: nbqa-pyupgrade
args: [--py37-plus]
- id: nbqa-isort
- id: nbqa-ruff
- id: nbqa
entry: nbqa mdformat
name: nbqa-mdformat
alias: nbqa-mdformat
additional_dependencies: [mdformat==0.7.14]

- repo: https://github.com/asottile/pyupgrade
rev: v3.3.1
hooks:
- id: pyupgrade
args:
- "--py37-plus"

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-toml
- id: check-yaml
- id: debug-statements

- repo: https://github.com/keewis/blackdoc
rev: v0.3.8
Expand Down
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
graft cf_xarray/data
exclude cf_xarray/_version.py

graft cf_xarray/scripts
prune ci
dcherian marked this conversation as resolved.
Show resolved Hide resolved
prune doc
prune cf_xarray/tests
prune *.egg-info
prune .binder/
prune .github/
Expand Down
2 changes: 1 addition & 1 deletion doc/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ v0.7.5 (Nov 15, 2022)
By `Pascal Bourgault`_.
- Improve detection of bounds order by rellaxing check a bit (:pr:`361`).
By `Lars Buntemeyer`_.
- Performance improvements. (:pr:`358`). By `Luke Davis`
- Performance improvements. (:pr:`358`). By `Luke Davis`_
- Fix coordinate/axis detection (:pr:`359`). By `Martin Schupfner`_

v0.7.4 (July 14, 2022)
Expand Down
112 changes: 112 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,115 @@
[project]
name = "cf_xarray"
description = "A convenience wrapper for using CF attributes on xarray objects"
readme = "README.rst"
requires-python = ">=3.8"
license = {file = "LICENSE"}
keywords = ["xarray", "metadata", "CF conventions"]
classifiers = [
"Development Status :: 5 - Production/Stable",
"License :: OSI Approved :: Apache License",
dcherian marked this conversation as resolved.
Show resolved Hide resolved
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
]
dependencies = [
"xarray",
]
dynamic = ["version"]

[project.urls]
homepage = "https://cf-xarray.readthedocs.io"
documentation = "https://cf-xarray.readthedocs.io"
repository = "https://github.com/xarray-contrib/cf-xarray.git"
changelog = "https://github.com/xarray-contrib/cf-xarray/blob/main/doc/whats-new.rst"

[build-system]
requires = [
"xarray",
dcherian marked this conversation as resolved.
Show resolved Hide resolved
"setuptools>=45",
"wheel",
"setuptools_scm[toml]>=6.2",
"setuptools_scm_git_archive",
dcherian marked this conversation as resolved.
Show resolved Hide resolved
]
build-backend = "setuptools.build_meta"

[tool.setuptools]
include-package-data = false
packages = ["cf_xarray", "cf_xarray.scripts"]

[tool.setuptools.dynamic]
version = {attr = "cf_xarray.__version__"}

[tool.setuptools_scm]
fallback_version = "999"
write_to = "cf_xarray/_version.py"
write_to_template= '__version__ = "{version}"'
tag_regex= "^(?P<prefix>v)?(?P<version>[^\\+]+)(?P<suffix>.*)?$"

[tool.black]
target-version = ["py38"]

[tool.ruff]
target-version = "py38"
builtins = ["ellipsis"]
exclude = [
".eggs",
"doc",
]
# E402: module level import not at top of file
# E501: line too long - let black worry about that
# E731: do not assign a lambda expression, use a def
ignore = [
"E402",
"E501",
"E731",
]
select = [
# Pyflakes
"F",
# Pycodestyle
"E",
"W",
# isort
"I",
# Pyupgrade
"UP",
]

[tool.ruff.isort]
known-first-party = ["cf_xarray"]
known-third-party = [
"dask",
"matplotlib",
"numpy",
"pandas",
"pint",
"pkg_resources",
"pytest",
"setuptools",
"sphinx_autosummary_accessors",
"xarray"
]

[tool.pytest]
python_files = "test_*.py"
testpaths = ["cf_xarray/tests"]

[tool.rstcheck]
report_level = "WARNING"
ignore_roles = [
"pr",
"issue",
]
ignore_directives = [
"ipython",
"autodata",
"autosummary",
]

[tool.nbqa.md]
mdformat = true

Expand Down
55 changes: 0 additions & 55 deletions setup.cfg

This file was deleted.

13 changes: 0 additions & 13 deletions setup.py

This file was deleted.