Skip to content

Commit c17c8e3

Browse files
sbillingesbillinge
authored
Merge pull request #77 from cadenmyers13/cookiecutv2
style: cookiecutter and pre-commit formatting updates
2 parents 1521c33 + 9216a29 commit c17c8e3

17 files changed

+208
-78
lines changed

‎.flake8

Lines changed: 3 additions & 1 deletion
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

‎.gitignore

Lines changed: 0 additions & 7 deletions
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

Lines changed: 2 additions & 1 deletion
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

‎AUTHORS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Authors
22
=======
33

4-
Billinge Group and community contributors.
4+
Billinge Group members and community contributors
55

66
Contributors
77
------------

‎LICENSE.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2024, The Trustees of Columbia University
4-
in the City of New York.
3+
Copyright (c) 2022-2025, The Trustees of Columbia University in the City of New York.
54
All rights reserved.
65

76
Redistribution and use in source and binary forms, with or without

‎README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
3636
:target: https://github.com/diffpy/diffpy.fourigui/issues
3737

38-
Tool for visualizing 3D diffraction and PDF Images.
38+
Tool for visualizing 3D diffraction and PDF images.
3939

4040
Diffpy.fourigui is a tool to visualize and process 3D data sets written with the Python programming language.
4141
Diffpy.fourigui always displays one slice perpendicular to one axis and allows scrolling through the 3D data set along

‎doc/source/conf.py

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,13 @@
223223
# (source start file, target name, title,
224224
# author, documentclass [howto, manual, or own class]).
225225
latex_documents = [
226-
("index", "diffpy.fourigui.tex", "diffpy.fourigui Documentation", ab_authors, "manual"),
226+
(
227+
"index",
228+
"diffpy.fourigui.tex",
229+
"diffpy.fourigui Documentation",
230+
ab_authors,
231+
"manual",
232+
),
227233
]
228234

229235
# The name of an image file (relative to this directory) to place at the top of
@@ -251,7 +257,15 @@
251257

252258
# One entry per manual page. List of tuples
253259
# (source start file, name, description, authors, manual section).
254-
man_pages = [("index", "diffpy.fourigui", "diffpy.fourigui Documentation", ab_authors, 1)]
260+
man_pages = [
261+
(
262+
"index",
263+
"diffpy.fourigui",
264+
"diffpy.fourigui Documentation",
265+
ab_authors,
266+
1,
267+
)
268+
]
255269

256270
# If true, show URL addresses after external links.
257271
# man_show_urls = False

‎doc/source/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
.. |title| replace:: diffpy.fourigui documentation
66

7-
diffpy.fourigui - Tool for visualizing 3D diffraction and PDF Images..
7+
diffpy.fourigui - Tool for visualizing 3D diffraction and PDF images.
88

99
| Software version |release|.
1010
| Last updated |today|.
@@ -37,7 +37,6 @@ Table of contents
3737
release
3838
Package API <api/diffpy.fourigui>
3939

40-
4140
=======
4241
Indices
4342
=======

‎doc/source/license.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ OPEN SOURCE LICENSE AGREEMENT
99
=============================
1010
BSD 3-Clause License
1111

12-
Copyright (c) 2024, The Trustees of Columbia University in
13-
the City of New York.
12+
Copyright (c) 2022-2025, The Trustees of Columbia University in the City of New York.
1413
All Rights Reserved.
1514

1615
Redistribution and use in source and binary forms, with or without

‎news/copyright-styling.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**Added:**
2+
3+
* <news item>
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+
* Update copyright to 2022-2025.
20+
* Format code to comply with group standards.
21+
22+
**Security:**
23+
24+
* <news item>

‎pyproject.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ build-backend = "setuptools.build_meta"
66
name = "diffpy.fourigui"
77
dynamic=['version', 'dependencies']
88
authors = [
9-
{ name="Simon J.L. Billinge group", email="[email protected]" },
9+
{ name="Simon Billinge", email="[email protected]" },
1010
]
1111
maintainers = [
12-
{ name="Simon J.L. Billinge group", email="[email protected]" },
12+
{ name="Simon Billinge", email="[email protected]" },
1313
]
14-
description = "Tool for visualizing 3D diffraction and PDF Images."
15-
keywords = ['diffraction', 'pdf', 'pair distribution function', 'gui']
14+
description = "Tool for visualizing 3D diffraction and PDF images."
15+
keywords = ['diffraction', 'PDF', 'pair distribution function', 'gui']
1616
readme = "README.rst"
1717
requires-python = ">=3.11, <3.14"
1818
classifiers = [
@@ -60,7 +60,7 @@ ignore-words = ".codespell/ignore_words.txt"
6060
skip = "*.cif,*.dat"
6161

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

‎src/diffpy/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python
22
##############################################################################
33
#
4-
# (c) 2024 The Trustees of Columbia University in the City of New York.
4+
# (c) 2022-2025 The Trustees of Columbia University in the City of New York.
55
# All rights reserved.
66
#
77
# File coded by: Billinge Group members and community contributors.

‎src/diffpy/fourigui/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python
22
##############################################################################
33
#
4-
# (c) 2024 The Trustees of Columbia University in the City of New York.
4+
# (c) 2022-2025 The Trustees of Columbia University in the City of New York.
55
# All rights reserved.
66
#
77
# File coded by: Billinge Group members and community contributors.
@@ -12,7 +12,7 @@
1212
# See LICENSE.rst for license information.
1313
#
1414
##############################################################################
15-
"""Tool for visualizing 3D diffraction and PDF Images."""
15+
"""Tool for visualizing 3D diffraction and PDF images."""
1616

1717
# package version
1818
from diffpy.fourigui.version import __version__

0 commit comments

Comments
 (0)