Skip to content

Commit f72815f

Browse files
sbillingesbillinge
authored
Merge pull request #25 from bobleesj/tests-fold
Cookiecutter - move tests folder, add entry point, conduct functional tests
2 parents d677d87 + 6499ce8 commit f72815f

File tree

220 files changed

+824
-657
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

220 files changed

+824
-657
lines changed

‎.codespell/ignore_lines.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
;; Please include filenames and explanations for each ignored line.
2+
;; See https://docs.openverse.org/meta/codespell.html for docs.

‎.codespell/ignore_words.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
;; Please include explanations for each ignored word (lowercase).
2+
;; See https://docs.openverse.org/meta/codespell.html for docs.
3+
4+
;; abbreviation for "materials" often used in a journal title
5+
mater
6+
7+
;; alternative use of socioeconomic
8+
socio-economic
9+
10+
;; Frobenius norm used in np.linalg.norm
11+
fro

‎.gitattributes

-1
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_feature.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Bug Report or Feature Request
3+
about: Report a bug or suggest a new feature!
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
### Problem
10+
11+
<!--
12+
For a bug report, please copy and paste any error messages from the application or command-line here.
13+
For a feature request, please state how the new functionality could benefit the community.
14+
-->
15+
16+
### Proposed solution

‎.github/ISSUE_TEMPLATE/release_checklist.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Release
3+
about: Checklist and communication channel for PyPI and GitHub release
4+
title: "Ready for <version-number> PyPI/GitHub release"
5+
labels: "release"
6+
assignees: ""
7+
---
8+
9+
### Release checklist for GitHub contributors
10+
11+
- [ ] All PRs/issues attached to the release are merged.
12+
- [ ] All the badges on the README are passing.
13+
- [ ] License information is verified as correct. If you are unsure, please comment below.
14+
- [ ] 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 and
17+
tested
18+
- [ ] Successfully run any tutorial examples or do functional testing in some other way.
19+
- [ ] Grammar and writing quality have been checked (no typos).
20+
21+
Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as
22+
version information and details about the pre-release.

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

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Release (GitHub/PyPI) and Deploy Docs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
tags:
7+
- '*' # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml
8+
9+
jobs:
10+
release:
11+
uses: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
12+
with:
13+
project: diffpy.nmf_mapping
14+
secrets:
15+
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
16+
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}

‎.github/workflows/check-news-item.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Check for News
2+
3+
on:
4+
pull_request_target:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
uses: Billingegroup/release-scripts/.github/workflows/_check-news-item.yml@v0
11+
with:
12+
project: diffpy.nmf_mapping

‎.github/workflows/docs.yml

-43
This file was deleted.

‎.github/workflows/main.yml

-60
This file was deleted.

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

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
release:
8+
types:
9+
- prereleased
10+
- published
11+
workflow_dispatch:
12+
13+
jobs:
14+
coverage:
15+
uses: Billingegroup/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
16+
with:
17+
project: diffpy.nmf_mapping
18+
c_extension: false
19+
headless: false
20+
secrets:
21+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎.github/workflows/pre-commit.yml

-19
This file was deleted.

‎.github/workflows/tests-on-pr.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Tests on PR
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
workflow_dispatch:
9+
10+
jobs:
11+
validate:
12+
uses: Billingegroup/release-scripts/.github/workflows/_tests-on-pr.yml@v0
13+
with:
14+
project: diffpy.nmf_mapping
15+
c_extension: false
16+
headless: false

‎.pre-commit-config.yaml

+10-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ repos:
1616
- id: check-yaml
1717
- id: end-of-file-fixer
1818
- id: trailing-whitespace
19-
exclude: '\.(rst|txt)$'
19+
- id: check-case-conflict
20+
- id: check-merge-conflict
21+
- id: check-toml
22+
- id: check-added-large-files
2023
- repo: https://github.com/psf/black
2124
rev: 24.4.2
2225
hooks:
@@ -41,3 +44,9 @@ repos:
4144
name: Prevent Commit to Main Branch
4245
args: ["--branch", "main"]
4346
stages: [pre-commit]
47+
- repo: https://github.com/codespell-project/codespell
48+
rev: v2.3.0
49+
hooks:
50+
- id: codespell
51+
additional_dependencies:
52+
- tomli

‎.travis.yml

-35
This file was deleted.

‎AUTHORS.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
Authors
22
=======
33

4-
Billinge Group and community contibutors.
4+
Simon J. L. Billinge
5+
Zachary A. Thatcher
6+
Billinge Group and community contributors.
57

68
Contributors
79
------------

‎AUTHORS.txt

-2
This file was deleted.

‎LICENSE.txt

-33
This file was deleted.

‎MANIFEST.in

+12-14
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
include AUTHORS.rst
2-
include LICENSE
3-
include README.rst
4-
include requirements.txt
5-
6-
recursive-exclude * __pycache__
7-
recursive-exclude * *.py[co]
8-
9-
recursive-include docs *.rst conf.py Makefile make.bat
10-
11-
include diffpy.nmf_mapping/version.py
12-
13-
# If including data files in the package, add them like:
14-
# include path/to/data_file
1+
graft src
2+
graft tests
3+
graft requirements
4+
5+
include AUTHORS.rst LICENSE*.rst README.rst
6+
7+
# Exclude all bytecode files and __pycache__ directories
8+
global-exclude *.py[cod] # Exclude all .pyc, .pyo, and .pyd files.
9+
global-exclude .DS_Store # Exclude Mac filesystem artifacts.
10+
global-exclude __pycache__ # Exclude Python cache directories.
11+
global-exclude .git* # Exclude git files and directories.
12+
global-exclude .idea # Exclude PyCharm project settings.

0 commit comments

Comments
 (0)