Skip to content

Commit 24e4f72

Browse files
sbillingesbillinge
authored
Merge pull request #84 from cadenmyers13/cookierelease
Running cookiecutter on labpdfproc
2 parents 8a47874 + a94d59e commit 24e4f72

Some content is hidden

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

42 files changed

+1105
-400
lines changed

Diff for: ‎.codecov.yml

+29-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
1-
# show coverage in CI status, not as a comment.
2-
comment: off
1+
# codecov can find this file anywhere in the repo, so we don't need to clutter
2+
# the root folder.
3+
#comment: false
4+
5+
codecov:
6+
notify:
7+
require_ci_to_pass: no
8+
39
coverage:
410
status:
5-
project:
6-
default:
7-
target: auto
811
patch:
912
default:
13+
target: '70'
14+
if_no_uploads: error
15+
if_not_found: success
16+
if_ci_failed: failure
17+
project:
18+
default: false
19+
library:
1020
target: auto
21+
if_no_uploads: error
22+
if_not_found: success
23+
if_ci_failed: error
24+
paths: '!*/tests/.*'
25+
26+
tests:
27+
target: 97.9%
28+
paths: '*/tests/.*'
29+
if_not_found: success
30+
31+
flags:
32+
tests:
33+
paths:
34+
- tests/

Diff for: ‎.coveragerc

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[run]
22
source =
3-
src
4-
3+
diffpy.labpdfproc
54
[report]
65
omit =
76
*/python?.?/*

Diff for: ‎.flake8

+3-4
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ exclude =
44
__pycache__,
55
build,
66
dist,
7-
versioneer.py,
8-
labpdfproc/_version.py,
9-
doc/manual/source/conf.py
7+
doc/source/conf.py
108
max-line-length = 115
119
# Ignore some style 'errors' produced while formatting by 'black'
12-
ignore = E203, W503
10+
# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings
11+
extend-ignore = E203

Diff for: ‎.gitattributes

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
labpdfproc/_version.py export-subst
1+
diffpy.labpdfproc/_version.py export-subst

Diff for: ‎.github/workflows/docs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ jobs:
3434
run: python -m pip install . --no-deps
3535

3636
- name: build documents
37-
run: make -C doc/manual html
37+
run: make -C doc html
3838

3939
- name: Deploy
4040
uses: peaceiris/actions-gh-pages@v3
4141
with:
4242
github_token: ${{ secrets.GITHUB_TOKEN }}
43-
publish_dir: ./doc/manual/build/html
43+
publish_dir: ./doc/build/html

Diff for: ‎.github/workflows/testing.yml renamed to ‎.github/workflows/main.yml

+3-4
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,13 @@ jobs:
4242
conda config --set always_yes yes --set changeps1 no
4343
conda config --add channels conda-forge
4444
conda activate test
45-
conda install --file requirements/requirements.txt
46-
conda install --file requirements/requirements-dev.txt
45+
conda install --file requirements/run.txt
46+
conda install --file requirements/test.txt
4747
pip install .
48-
4948
- name: Validate diffpy.labpdfproc
5049
shell: bash -l {0}
5150
run: |
5251
conda activate test
53-
coverage run -m pytest -s
52+
coverage run -m pytest -vv -s
5453
coverage report -m
5554
codecov

Diff for: ‎.github/workflows/pre-commit.yml

-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ jobs:
1414
steps:
1515
- uses: actions/checkout@v3
1616
- uses: actions/setup-python@v4
17-
- name: Make prevent_commit_to_main.sh executable
18-
run: chmod +x ./prevent_commit_to_main.sh
1917
- uses: pre-commit/[email protected]
2018
with:
2119
extra_args: --all-files

Diff for: ‎.gitignore

+17
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ venv/
2424
*.egg-info/
2525
.installed.cfg
2626
*.egg
27+
bin/
28+
temp/
29+
tags/
30+
errors.err
2731

2832
# PyInstaller
2933
# Usually these files are written by a python script from a template
@@ -34,6 +38,7 @@ venv/
3438
# Installer logs
3539
pip-log.txt
3640
pip-delete-this-directory.txt
41+
MANIFEST
3742

3843
# Unit test / coverage reports
3944
htmlcov/
@@ -50,6 +55,11 @@ coverage.xml
5055
*.mo
5156
*.pot
5257

58+
# Mr Developer
59+
.mr.developer.cfg
60+
.project
61+
.pydevproject
62+
5363
# Django stuff:
5464
*.log
5565

@@ -80,3 +90,10 @@ target/
8090

8191
# Ipython Notebook
8292
.ipynb_checkpoints
93+
94+
# version information
95+
setup.cfg
96+
/src/diffpy/*/version.cfg
97+
98+
# Rever
99+
rever/

Diff for: ‎AUTHORS.rst

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1+
Authors
12
=======
2-
Credits
3-
=======
4-
5-
Maintainer
6-
----------
73

8-
* diffpy <[email protected]>
4+
Billinge Group and community contibutors.
95

106
Contributors
117
------------
128

13-
None yet. Why not be the first? See: CONTRIBUTING.rst
9+
For a list of contributors, visit
10+
https://github.com/diffpy/diffpy.labpdfproc/graphs/contributors

Diff for: ‎CHANGELOG.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
=============
2+
Release Notes
3+
=============
4+
5+
.. current developments
6+
7+
Initial release of labPDFproc. Please see README and documentation for details

Diff for: ‎CODE_OF_CONDUCT.rst

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
=====================================
2+
Contributor Covenant Code of Conduct
3+
=====================================
4+
5+
Our Pledge
6+
----------
7+
8+
We as members, contributors, and leaders pledge to make participation in our
9+
community a harassment-free experience for everyone, regardless of age, body
10+
size, visible or invisible disability, ethnicity, sex characteristics, gender
11+
identity and expression, level of experience, education, socio-economic status,
12+
nationality, personal appearance, race, caste, color, religion, or sexual
13+
identity and orientation.
14+
15+
We pledge to act and interact in ways that contribute to an open, welcoming,
16+
diverse, inclusive, and healthy community.
17+
18+
Our Standards
19+
-------------
20+
21+
Examples of behavior that contributes to a positive environment for our
22+
community include:
23+
24+
* Demonstrating empathy and kindness toward other people
25+
* Being respectful of differing opinions, viewpoints, and experiences
26+
* Giving and gracefully accepting constructive feedback
27+
* Accepting responsibility and apologizing to those affected by our mistakes,
28+
and learning from the experience
29+
* Focusing on what is best not just for us as individuals, but for the overall
30+
community
31+
32+
Examples of unacceptable behavior include:
33+
34+
* The use of sexualized language or imagery, and sexual attention or advances of
35+
any kind
36+
* Trolling, insulting or derogatory comments, and personal or political attacks
37+
* Public or private harassment
38+
* Publishing others' private information, such as a physical or email address,
39+
without their explicit permission
40+
* Other conduct which could reasonably be considered inappropriate in a
41+
professional setting
42+
43+
Enforcement Responsibilities
44+
----------------------------
45+
46+
Community leaders are responsible for clarifying and enforcing our standards of
47+
acceptable behavior and will take appropriate and fair corrective action in
48+
response to any behavior that they deem inappropriate, threatening, offensive,
49+
or harmful.
50+
51+
Community leaders have the right and responsibility to remove, edit, or reject
52+
comments, commits, code, wiki edits, issues, and other contributions that are
53+
not aligned to this Code of Conduct, and will communicate reasons for moderation
54+
decisions when appropriate.
55+
56+
Scope
57+
-----
58+
59+
This Code of Conduct applies within all community spaces, and also applies when
60+
an individual is officially representing the community in public spaces.
61+
Examples of representing our community include using an official email address,
62+
posting via an official social media account, or acting as an appointed
63+
representative at an online or offline event.
64+
65+
Enforcement
66+
-----------
67+
68+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
69+
reported to the community leaders responsible for enforcement at
70+
[email protected]. All complaints will be reviewed and investigated promptly and fairly.
71+
72+
All community leaders are obligated to respect the privacy and security of the
73+
reporter of any incident.
74+
75+
Enforcement Guidelines
76+
----------------------
77+
78+
Community leaders will follow these Community Impact Guidelines in determining
79+
the consequences for any action they deem in violation of this Code of Conduct:
80+
81+
1. Correction
82+
****************
83+
84+
**Community Impact**: Use of inappropriate language or other behavior deemed
85+
unprofessional or unwelcome in the community.
86+
87+
**Consequence**: A private, written warning from community leaders, providing
88+
clarity around the nature of the violation and an explanation of why the
89+
behavior was inappropriate. A public apology may be requested.
90+
91+
2. Warning
92+
*************
93+
94+
**Community Impact**: A violation through a single incident or series of
95+
actions.
96+
97+
**Consequence**: A warning with consequences for continued behavior. No
98+
interaction with the people involved, including unsolicited interaction with
99+
those enforcing the Code of Conduct, for a specified period of time. This
100+
includes avoiding interactions in community spaces as well as external channels
101+
like social media. Violating these terms may lead to a temporary or permanent
102+
ban.
103+
104+
3. Temporary Ban
105+
******************
106+
107+
**Community Impact**: A serious violation of community standards, including
108+
sustained inappropriate behavior.
109+
110+
**Consequence**: A temporary ban from any sort of interaction or public
111+
communication with the community for a specified period of time. No public or
112+
private interaction with the people involved, including unsolicited interaction
113+
with those enforcing the Code of Conduct, is allowed during this period.
114+
Violating these terms may lead to a permanent ban.
115+
116+
4. Permanent Ban
117+
******************
118+
119+
**Community Impact**: Demonstrating a pattern of violation of community
120+
standards, including sustained inappropriate behavior, harassment of an
121+
individual, or aggression toward or disparagement of classes of individuals.
122+
123+
**Consequence**: A permanent ban from any sort of public interaction within the
124+
community.
125+
126+
Attribution
127+
-----------
128+
129+
This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>`_.
130+
131+
Community Impact Guidelines were inspired by `Mozilla's code of conduct enforcement ladder <https://github.com/mozilla/inclusion>`_.
132+
133+
For answers to common questions about this code of conduct, see the `FAQ <https://www.contributor-covenant.org/faq>`_. `Translations are available <https://www.contributor-covenant.org/translations>`_

Diff for: ‎LICENSE.rst

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2024, The Trustees of Columbia University
4+
in the City of New York.
5+
All rights reserved.
6+
7+
Redistribution and use in source and binary forms, with or without
8+
modification, are permitted provided that the following conditions are met:
9+
10+
1. Redistributions of source code must retain the above copyright notice, this
11+
list of conditions and the following disclaimer.
12+
13+
2. Redistributions in binary form must reproduce the above copyright notice,
14+
this list of conditions and the following disclaimer in the documentation
15+
and/or other materials provided with the distribution.
16+
17+
3. Neither the name of the copyright holder nor the names of its contributors
18+
may be used to endorse or promote products derived from this software
19+
without specific prior written permission.
20+
21+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Diff for: ‎MANIFEST.in

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
include AUTHORS.rst
2-
include CONTRIBUTING.rst
32
include LICENSE
43
include README.rst
54
include requirements.txt
6-
include docs/examples/*
5+
include doc/examples/*
76

87
recursive-exclude * __pycache__
98
recursive-exclude * *.py[co]
109

1110
recursive-include docs *.rst conf.py Makefile make.bat
1211

13-
include versioneer.py
14-
include labpdfproc/_version.py
12+
13+
include diffpy.labpdfproc/version.py
1514

1615
# If including data files in the package, add them like:
1716
# include path/to/data_file

0 commit comments

Comments
 (0)