-
-
Notifications
You must be signed in to change notification settings - Fork 21
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
Updates from package template #116
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"template": "https://github.com/sunpy/package-template", | ||
"commit": "51fb616094a4d7577c8898445aa50effb89afa31", | ||
"commit": "c60ccf2ddc71d3cf126cea15132a15da307864f7", | ||
"checkout": null, | ||
"context": { | ||
"cookiecutter": { | ||
|
@@ -10,6 +10,12 @@ | |
"author_name": "The SunPy Community", | ||
"author_email": "[email protected]", | ||
"project_url": "https://sunpy.org", | ||
"github_repo": "", | ||
"sourcecode_url": "", | ||
"download_url": "https://pypi.org/project/radiospectra", | ||
"documentation_url": "", | ||
"changelog_url": "", | ||
"issue_tracker_url": "", | ||
"license": "BSD 2-Clause", | ||
"minimum_python_version": "3.10", | ||
"use_compiled_extensions": "n", | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
name: Label Sync | ||
on: | ||
workflow_dispatch: | ||
schedule: | ||
# ┌───────── minute (0 - 59) | ||
# │ ┌───────── hour (0 - 23) | ||
# │ │ ┌───────── day of the month (1 - 31) | ||
# │ │ │ ┌───────── month (1 - 12 or JAN-DEC) | ||
# │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT) | ||
- cron: '0 0 * * *' # run every day at midnight UTC | ||
|
||
# Give permissions to write issue labels | ||
permissions: | ||
issues: write | ||
|
||
jobs: | ||
label_sync: | ||
runs-on: ubuntu-latest | ||
name: Label Sync | ||
steps: | ||
- uses: srealmoreno/label-sync-action@850ba5cef2b25e56c6c420c4feed0319294682fd | ||
with: | ||
config-file: https://raw.githubusercontent.com/sunpy/.github/main/labels.yml |
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -16,43 +16,55 @@ select = [ | |||||||||||
"PT", | ||||||||||||
] | ||||||||||||
extend-ignore = [ | ||||||||||||
# pycodestyle | ||||||||||||
# pycodestyle (E, W) | ||||||||||||
"E501", # ignore line length will use a formatter instead | ||||||||||||
"E712", # Avoid equality comparisons to True; use if {cond}: for truth checks | ||||||||||||
"E721", # type comparison Use is and is not for type comparisons, or isinstance() for isinstance checks | ||||||||||||
# upgrades | ||||||||||||
# pyupgrade (UP) | ||||||||||||
"UP038", # Use | in isinstance - not compatible with models and is slower | ||||||||||||
# pytest (PT) | ||||||||||||
"PT001", # Always use pytest.fixture() | ||||||||||||
"PT004", # Fixtures which don't return anything should have leading _ | ||||||||||||
"PT011", # except(ValueRaises) is too broad | ||||||||||||
"PT023", # Always use () on pytest decorators | ||||||||||||
# flake8-pie | ||||||||||||
# flake8-pie (PIE) | ||||||||||||
"PIE808", # Disallow passing 0 as the first argument to range | ||||||||||||
# flake8-use-pathlib | ||||||||||||
# flake8-use-pathlib (PTH) | ||||||||||||
"PTH123", # open() should be replaced by Path.open() | ||||||||||||
# Ruff | ||||||||||||
# Ruff (RUF) | ||||||||||||
"RUF003", # Ignore ambiguous quote marks, doesn't allow ' in comments | ||||||||||||
"RUF012", # Mutable class attributes should be annotated with `typing.ClassVar` | ||||||||||||
"RUF013", # PEP 484 prohibits implicit `Optional` | ||||||||||||
"RUF015", # Prefer `next(iter(...))` over single element slice | ||||||||||||
"RUF012", # Mutable class attributes should be annotated with `typing.ClassVar` | ||||||||||||
"RUF013", # PEP 484 prohibits implicit `Optional` | ||||||||||||
"RUF015", # Prefer `next(iter(...))` over single element slice | ||||||||||||
] | ||||||||||||
|
||||||||||||
[lint.per-file-ignores] | ||||||||||||
# Part of configuration, not a package. | ||||||||||||
"setup.py" = ["INP001"] | ||||||||||||
"conftest.py" = ["INP001"] | ||||||||||||
"setup.py" = [ | ||||||||||||
"INP001", # File is part of an implicit namespace package. | ||||||||||||
] | ||||||||||||
"conftest.py" = [ | ||||||||||||
"INP001", # File is part of an implicit namespace package. | ||||||||||||
] | ||||||||||||
"docs/conf.py" = [ | ||||||||||||
"E402" # Module imports not at top of file | ||||||||||||
"E402" # Module imports not at top of file | ||||||||||||
] | ||||||||||||
"docs/*.py" = [ | ||||||||||||
"INP001", # Implicit-namespace-package. The examples are not a package. | ||||||||||||
"INP001", # File is part of an implicit namespace package. | ||||||||||||
] | ||||||||||||
"examples/**.py" = [ | ||||||||||||
"T201", # allow use of print in examples | ||||||||||||
"INP001", # File is part of an implicit namespace package. | ||||||||||||
] | ||||||||||||
"__init__.py" = [ | ||||||||||||
"E402", # Module level import not at top of cell | ||||||||||||
"F401", # Unused import | ||||||||||||
"F403", # from {name} import * used; unable to detect undefined names | ||||||||||||
"F405", # {name} may be undefined, or defined from star imports | ||||||||||||
] | ||||||||||||
"test_*.py" = [ | ||||||||||||
"E402", # Module level import not at top of cell | ||||||||||||
] | ||||||||||||
<<<<<<< | ||||||||||||
"__init__.py" = ["E402", "F401", "F403", "F405"] | ||||||||||||
"test_*.py" = ["B011", "D", "E402", "PGH001", "S101"] | ||||||||||||
======= | ||||||||||||
>>>>>>> | ||||||||||||
Comment on lines
+63
to
+67
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.
Suggested change
|
||||||||||||
|
||||||||||||
[lint.pydocstyle] | ||||||||||||
convention = "numpy" |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -49,6 +49,14 @@ When you are interacting with the SunPy community you are asked to follow our `C | |||||||||||||||||||||||||||
.. toctree:: | ||||||||||||||||||||||||||||
:maxdepth: 2 | ||||||||||||||||||||||||||||
:caption: Contents: | ||||||||||||||||||||||||||||
<<<<<<< | ||||||||||||||||||||||||||||
======= | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
whatsnew/index | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Indices and tables | ||||||||||||||||||||||||||||
================== | ||||||||||||||||||||||||||||
>>>>>>> | ||||||||||||||||||||||||||||
Comment on lines
+52
to
+59
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.
Suggested change
|
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
overview | ||||||||||||||||||||||||||||
code_ref/index | ||||||||||||||||||||||||||||
|
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -37,13 +37,18 @@ docs = [ | |||||||||||||
"sphinx", | ||||||||||||||
"sphinx-automodapi", | ||||||||||||||
"sphinx-changelog", | ||||||||||||||
<<<<<<< | ||||||||||||||
"sphinx-gallery", | ||||||||||||||
======= | ||||||||||||||
>>>>>>> | ||||||||||||||
"sunpy-sphinx-theme", | ||||||||||||||
"packaging", | ||||||||||||||
|
||||||||||||||
] | ||||||||||||||
|
||||||||||||||
[project.urls] | ||||||||||||||
repository = "https://sunpy.org" | ||||||||||||||
Homepage = "https://sunpy.org" | ||||||||||||||
Download = "https://pypi.org/project/radiospectra" | ||||||||||||||
|
||||||||||||||
[tool.setuptools] | ||||||||||||||
zip-safe = false | ||||||||||||||
|
@@ -132,7 +137,72 @@ exclude = ''' | |||||||||||||
name = "Documentation Fixes" | ||||||||||||||
showcontent = true | ||||||||||||||
|
||||||||||||||
<<<<<<< | ||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "trivial" | ||||||||||||||
name = "Trivial/Internal Changes" | ||||||||||||||
showcontent = true | ||||||||||||||
======= | ||||||||||||||
Comment on lines
+140
to
+145
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.
Suggested change
|
||||||||||||||
[tool.setuptools_scm] | ||||||||||||||
write_to = "radiospectra/_version.py" | ||||||||||||||
|
||||||||||||||
[tool.gilesbot] | ||||||||||||||
[tool.gilesbot.pull_requests] | ||||||||||||||
enabled = true | ||||||||||||||
|
||||||||||||||
[tool.gilesbot.towncrier_changelog] | ||||||||||||||
enabled = true | ||||||||||||||
verify_pr_number = true | ||||||||||||||
changelog_skip_label = "No Changelog Entry Needed" | ||||||||||||||
help_url = "https://github.com//blob/main/changelog/README.rst" | ||||||||||||||
|
||||||||||||||
changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com//blob/main/changelog/README.rst)." | ||||||||||||||
|
||||||||||||||
type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com//blob/main/changelog/README.rst)" | ||||||||||||||
|
||||||||||||||
number_incorrect_long = "The number in the changelog file you added does not match the number of this pull request. Please rename the file." | ||||||||||||||
|
||||||||||||||
# TODO: This should be in towncrier.toml but Giles currently only works looks in | ||||||||||||||
# pyproject.toml we should move this back when it's fixed. | ||||||||||||||
[tool.towncrier] | ||||||||||||||
package = "radiospectra" | ||||||||||||||
filename = "CHANGELOG.rst" | ||||||||||||||
directory = "changelog/" | ||||||||||||||
issue_format = "`#{issue} <https://github.com//pull/{issue}>`__" | ||||||||||||||
title_format = "{version} ({project_date})" | ||||||||||||||
|
||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "breaking" | ||||||||||||||
name = "Breaking Changes" | ||||||||||||||
showcontent = true | ||||||||||||||
|
||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "deprecation" | ||||||||||||||
name = "Deprecations" | ||||||||||||||
showcontent = true | ||||||||||||||
|
||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "removal" | ||||||||||||||
name = "Removals" | ||||||||||||||
showcontent = true | ||||||||||||||
|
||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "feature" | ||||||||||||||
name = "New Features" | ||||||||||||||
showcontent = true | ||||||||||||||
|
||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "bugfix" | ||||||||||||||
name = "Bug Fixes" | ||||||||||||||
showcontent = true | ||||||||||||||
|
||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "doc" | ||||||||||||||
name = "Documentation" | ||||||||||||||
showcontent = true | ||||||||||||||
|
||||||||||||||
[[tool.towncrier.type]] | ||||||||||||||
directory = "trivial" | ||||||||||||||
name = "Internal Changes" | ||||||||||||||
showcontent = true | ||||||||||||||
>>>>>>> | ||||||||||||||
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.
Suggested change
|
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.