-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Registers NdCube with the SunPy template
- Loading branch information
1 parent
d1db721
commit 6ee0b2d
Showing
15 changed files
with
168 additions
and
45 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
|
@@ -4,3 +4,8 @@ coverage: | |
project: | ||
default: | ||
threshold: 0.2% | ||
|
||
codecov: | ||
require_ci_to_pass: false | ||
notify: | ||
wait_for_ci: true |
This file contains 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,13 @@ | ||
[codespell] | ||
skip = *.asdf,*.fits,*.fts,*.header,*.json,*.xsh,*cache*,*egg*,*extern*,.git,.idea,.tox,_build,*truncated,*.svg,.asv_env,.history | ||
ignore-words-list = | ||
alog, | ||
nd, | ||
nin, | ||
observ, | ||
ot, | ||
te, | ||
upto, | ||
afile, | ||
precessed, | ||
precess |
This file contains 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,30 @@ | ||
[run] | ||
omit = | ||
ndcube/conftest.py | ||
ndcube/*setup_package* | ||
ndcube/extern/* | ||
ndcube/version* | ||
*/ndcube/conftest.py | ||
*/ndcube/*setup_package* | ||
*/ndcube/extern/* | ||
*/ndcube/version* | ||
|
||
[report] | ||
exclude_lines = | ||
# Have to re-enable the standard pragma | ||
pragma: no cover | ||
# Don't complain about packages we have installed | ||
except ImportError | ||
# Don't complain if tests don't hit assertions | ||
raise AssertionError | ||
raise NotImplementedError | ||
# Don't complain about script hooks | ||
def main(.*): | ||
# Ignore branches that don't pertain to this version of Python | ||
pragma: py{ignore_python_version} | ||
# Don't complain about IPython completion helper | ||
def _ipython_key_completions_ | ||
# typing.TYPE_CHECKING is False at runtime | ||
if TYPE_CHECKING: | ||
# Ignore typing overloads | ||
@overload |
This file contains 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,6 +1,6 @@ | ||
{ | ||
"template": "/home/sam/Code/OpenAstronomy/../OpenAstronomy/packaging-guide", | ||
"commit": "79c7c63fa9f20c7873063e08516778e99dd39318", | ||
"template": "https://github.com/sunpy/package-template", | ||
"commit": "6d6729b22066ef890e70c37438da70cac33e03b4", | ||
"checkout": null, | ||
"context": { | ||
"cookiecutter": { | ||
|
@@ -9,7 +9,7 @@ | |
"short_description": "A package for multi-dimensional contiguous and non-contiguous coordinate aware arrays.", | ||
"author_name": "The SunPy Community", | ||
"author_email": "[email protected]", | ||
"project_url": "https://docs.sunpy.org/projects/ndcube/", | ||
"project_url": "https://docs.sunpy.org/projects/ndcube", | ||
"license": "BSD 2-Clause", | ||
"minimum_python_version": "3.9", | ||
"use_compiled_extensions": "n", | ||
|
@@ -24,7 +24,7 @@ | |
"docs/_static", | ||
".github/workflows/sub_package_update.yml" | ||
], | ||
"_template": "/home/sam/Code/OpenAstronomy/../OpenAstronomy/packaging-guide" | ||
"_template": "https://github.com/sunpy/package-template" | ||
} | ||
}, | ||
"directory": null | ||
|
This file contains 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 |
---|---|---|
|
@@ -22,6 +22,6 @@ exclude = | |
__pycache__ | ||
docs/conf.py | ||
build | ||
ndcube/__init__.py, | ||
ndcube/__init__.py | ||
rst-directives = | ||
plot |
This file contains 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 contains 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 contains 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 contains 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,16 @@ | ||
[settings] | ||
balanced_wrapping = true | ||
skip = | ||
docs/conf.py | ||
ndcube/__init__.py | ||
default_section = THIRDPARTY | ||
include_trailing_comma = true | ||
known_astropy = astropy, asdf | ||
known_sunpy = sunpy | ||
known_first_party = ndcube | ||
length_sort = false | ||
length_sort_sections = stdlib | ||
line_length = 110 | ||
multi_line_output = 3 | ||
no_lines_before = LOCALFOLDER | ||
sections = STDLIB, THIRDPARTY, ASTROPY, SUNPY, FIRSTPARTY, LOCALFOLDER |
This file contains 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 contains 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 contains 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 |
---|---|---|
|
@@ -8,8 +8,8 @@ build-backend = "setuptools.build_meta" | |
[project] | ||
name = "ndcube" | ||
description = "A package for multi-dimensional contiguous and non-contiguous coordinate aware arrays." | ||
readme = "README.rst" | ||
requires-python = ">=3.9" | ||
readme = { file = "README.rst", content-type = "text/x-rst" } | ||
license = { file = "licenses/LICENSE.rst", content-type = "text/plain" } | ||
authors = [ | ||
{ name = "The SunPy Community", email = "[email protected]" }, | ||
|
@@ -19,18 +19,18 @@ dynamic = ["version"] | |
|
||
[project.optional-dependencies] | ||
tests = [ | ||
"pytest", | ||
"pytest-doctestplus", | ||
"pytest-cov", | ||
"pytest", | ||
"pytest-doctestplus", | ||
"pytest-cov" | ||
] | ||
docs = [ | ||
"sphinx", | ||
"sphinx-automodapi", | ||
"sphinx", | ||
"sphinx-automodapi", | ||
"tomli; python_version <\"3.11\"", | ||
] | ||
|
||
[project.urls] | ||
repository = "https://docs.sunpy.org/projects/ndcube/" | ||
repository = "https://docs.sunpy.org/projects/ndcube" | ||
|
||
[tool.setuptools] | ||
zip-safe = false | ||
|
This file contains 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,27 @@ | ||
[pytest] | ||
minversion = 7.0 | ||
testpaths = | ||
ndcube | ||
docs | ||
norecursedirs = | ||
.tox | ||
build | ||
docs/_build | ||
docs/generated | ||
*.egg-info | ||
examples | ||
ndcube/_dev | ||
.history | ||
ndcube/extern | ||
doctest_plus = enabled | ||
doctest_optionflags = NORMALIZE_WHITESPACE FLOAT_CMP ELLIPSIS | ||
text_file_format = rst | ||
addopts = --doctest-rst -p no:unraisableexception -p no:threadexception | ||
filterwarnings = | ||
# Turn all warnings into errors so they do not pass silently. | ||
error | ||
# Do not fail on pytest config issues (i.e. missing plugins) but do show them | ||
always::pytest.PytestConfigWarning | ||
# A list of warnings to ignore follows. If you add to this list, you MUST | ||
# add a comment or ideally a link to an issue that explains why the warning | ||
# is being ignored |
This file contains 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,4 @@ | ||
#!/usr/bin/env python | ||
from setuptools import setup | ||
|
||
setup() |
This file contains 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