Skip to content

Commit 983a7b0

Browse files
sbillingesbillinge
authored
Merge pull request #156 from yucongalicechen/recut2
fix: re-cookiecut to follow new group standard
2 parents 8ef887c + d3c9eee commit 983a7b0

19 files changed

+570
-201
lines changed

‎.codecov.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
coverage:
22
status:
3-
project: # more options at https://docs.codecov.com/docs/commit-status
3+
project: # more options at https://docs.codecov.com/docs/commit-status
44
default:
55
target: auto # use the coverage from the base commit, fail if coverage is lower
6-
threshold: 0% # allow the coverage to drop by
6+
threshold: 0% # allow the coverage to drop by
77

88
comment:
99
layout: " diff, flags, files"
1010
behavior: default
1111
require_changes: false
12-
require_base: false # [true :: must have a base report to post]
13-
require_head: false # [true :: must have a head report to post]
12+
require_base: false # [true :: must have a base report to post]
13+
require_head: false # [true :: must have a head report to post]
1414
hide_project_coverage: false # [true :: only show coverage on the git diff aka patch coverage]

‎.flake8

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
# As of now, flake8 does not natively support configuration via pyproject.toml
2+
# https://github.com/microsoft/vscode-flake8/issues/135
13
[flake8]
24
exclude =
35
.git,
46
__pycache__,
57
build,
68
dist,
79
doc/source/conf.py
8-
max-line-length = 115
10+
max-line-length = 79
911
# Ignore some style 'errors' produced while formatting by 'black'
1012
# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings
1113
extend-ignore = E203

‎.github/ISSUE_TEMPLATE/release_checklist.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,41 @@ labels: "release"
66
assignees: ""
77
---
88

9-
### PyPI/GitHub release checklist:
9+
### PyPI/GitHub rc-release preparation checklist:
1010

1111
- [ ] All PRs/issues attached to the release are merged.
1212
- [ ] All the badges on the README are passing.
1313
- [ ] License information is verified as correct. If you are unsure, please comment below.
1414
- [ ] Locally rendered documentation contains all appropriate pages, including API references (check no modules are
15-
missing), tutorials, and other human written text is up-to-date with any changes in the code.
16-
- [ ] Installation instructions in the README, documentation and on the website (e.g., diffpy.org) are updated.
15+
missing), tutorials, and other human-written text is up-to-date with any changes in the code.
16+
- [ ] Installation instructions in the README, documentation, and the website (e.g., diffpy.org) are updated.
1717
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version.
1818
- [ ] Grammar and writing quality are checked (no typos).
19+
- [ ] Install `pip install build twine`, run `python -m build` and `twine check dist/*` to ensure that the package can be built and is correctly formatted for PyPI release.
1920

20-
Please mention @sbillinge here when you are ready for PyPI/GitHub release. Include any additional comments necessary, such as
21-
version information and details about the pre-release here:
21+
Please mention @sbillinge here when you are ready for PyPI/GitHub release. Include any additional comments necessary, such as version information and details about the pre-release here:
2222

23-
### conda-forge release checklist:
23+
### PyPI/GitHub full-release preparation checklist:
24+
25+
- [ ] Create a new conda environment and install the rc from PyPI (`pip install <package-name>==??`)
26+
- [ ] License information on PyPI is correct.
27+
- [ ] Docs are deployed successfully to `https://www.diffpy.org/<package-name>`.
28+
- [ ] Successfully run all tests, tutorial examples or do functional testing.
29+
30+
Please let @sbillinge know that all checks are done and the package is ready for full release.
31+
32+
### conda-forge release preparation checklist:
2433

2534
<!-- After @sbillinge releases the PyPI package, please check the following when creating a PR for conda-forge release.-->
2635

36+
- [ ] Ensure that the full release has appeared on PyPI successfully.
2737
- [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock.
28-
- [ ] All relevant issues in the feedstock are addressed in the release PR.
38+
- [ ] Close any open issues on the feedstock. Reach out to @bobleesj if you have questions.
39+
- [ ] Tag @sbillinge and @bobleesj for conda-forge release.
2940

3041
### Post-release checklist
3142

3243
<!-- Before closing this issue, please complete the following: -->
3344

34-
- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
35-
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.
45+
- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
46+
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.

‎.github/workflows/build-wheel-release-upload.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release (GitHub/PyPI)
1+
name: Release (GitHub/PyPI) and Deploy Docs
22

33
on:
44
workflow_dispatch:
@@ -11,6 +11,8 @@ jobs:
1111
uses: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
1212
with:
1313
project: diffpy.labpdfproc
14+
c_extension: false
15+
github_admin_username: sbillinge
1416
secrets:
1517
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
1618
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}

‎.github/workflows/matrix-and-codecov-on-merge-to-main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
workflow_dispatch:
1212

1313
jobs:
14-
coverage:
14+
matrix-coverage:
1515
defaults:
1616
run:
1717
shell: bash -l {0}

‎.github/workflows/publish-docs-on-release.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Deploy Documentation on Release
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
docs:
8+
uses: Billingegroup/release-scripts/.github/workflows/_publish-docs-on-release.yml@v0
9+
with:
10+
project: diffpy.labpdfproc
11+
c_extension: false
12+
headless: false

‎.gitignore

-7
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,3 @@ target/
9090

9191
# Ipython Notebook
9292
.ipynb_checkpoints
93-
94-
# version information
95-
setup.cfg
96-
/src/diffpy/*/version.cfg
97-
98-
# Rever
99-
rever/

‎.isort.cfg

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[settings]
2-
line_length = 115
2+
# Keep import statement below line_length character limit
3+
line_length = 79
34
multi_line_output = 3
45
include_trailing_comma = True

‎doc/source/conf.py

+16-2
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,13 @@
221221
# (source start file, target name, title,
222222
# author, documentclass [howto, manual, or own class]).
223223
latex_documents = [
224-
("index", "diffpy.labpdfproc.tex", "diffpy.labpdfproc Documentation", ab_authors, "manual"),
224+
(
225+
"index",
226+
"diffpy.labpdfproc.tex",
227+
"diffpy.labpdfproc Documentation",
228+
ab_authors,
229+
"manual",
230+
),
225231
]
226232

227233
# The name of an image file (relative to this directory) to place at the top of
@@ -249,7 +255,15 @@
249255

250256
# One entry per manual page. List of tuples
251257
# (source start file, name, description, authors, manual section).
252-
man_pages = [("index", "diffpy.labpdfproc", "diffpy.labpdfproc Documentation", ab_authors, 1)]
258+
man_pages = [
259+
(
260+
"index",
261+
"diffpy.labpdfproc",
262+
"diffpy.labpdfproc Documentation",
263+
ab_authors,
264+
1,
265+
)
266+
]
253267

254268
# If true, show URL addresses after external links.
255269
# man_show_urls = False

‎news/recut.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* no news: modified .github, .pre-commit-config.yaml and related files to follow new practice for commit and issues.
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

‎pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ ignore-words = ".codespell/ignore_words.txt"
6060
skip = "*.cif"
6161

6262
[tool.black]
63-
line-length = 115
63+
line-length = 79
6464
include = '\.pyi?$'
6565
exclude = '''
6666
/(

‎src/diffpy/labpdfproc/__init__.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
#
1414
##############################################################################
1515

16-
"""Tools for processing x-ray powder diffraction data from laboratory sources."""
16+
"""Tools for processing x-ray powder diffraction data
17+
from laboratory sources."""
1718

1819
# package version
1920
from diffpy.labpdfproc.version import __version__

0 commit comments

Comments
 (0)