Skip to content

Commit bd14a8f

Browse files
sbillingesbillinge
authored
Merge pull request #132 from Sparks29032/cookie
Cookie Cutter + PyPi fix
2 parents f0e2878 + 92b5801 commit bd14a8f

Some content is hidden

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

71 files changed

+179
-208
lines changed

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

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

‎.github/workflows/docs.yml

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎.github/workflows/main.yml

Lines changed: 0 additions & 54 deletions
This file was deleted.

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

Lines changed: 21 additions & 0 deletions
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.pdfmorph
18+
c_extension: false
19+
headless: false
20+
secrets:
21+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎.github/workflows/pre-commit.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Build and Deploy Docs
2+
3+
on:
4+
release:
5+
types:
6+
- published
7+
workflow_dispatch:
8+
9+
jobs:
10+
docs:
11+
uses: Billingegroup/release-scripts/.github/workflows/_publish-docs-on-release.yml@v0
12+
with:
13+
project: diffpy.pdfmorph
14+
c_extension: false

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

Lines changed: 16 additions & 0 deletions
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.pdfmorph
15+
c_extension: false
16+
headless: false

‎.pre-commit-config.yaml

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

‎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 contibutors.
4+
Billinge Group and community contributors.
55

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

‎MANIFEST.in

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +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 versioneer.py
12-
include diffpy.pdfmorph/_version.py
13-
14-
# If including data files in the package, add them like:
15-
# 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.

‎README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ REQUIREMENTS
7575
------------------------------------------------------------------------
7676

7777
PDFmorph is currently run from the command line, which requires opening
78-
and typing into a terminal window or Windows command prompt. It is
79-
recommended that you consult online resources and become somewhat
78+
and typing into a terminal window or Windows command prompt. It is
79+
recommended that you consult online resources and become somewhat
8080
familiar before using PDFmorph.
8181

8282
PDFmorph can be run with Python 3.10 or higher. It makes use of several third party
@@ -115,7 +115,7 @@ Another option is to use ``pip`` to download and install the latest release from
115115
`Python Package Index <https://pypi.python.org>`_.
116116
To install using ``pip`` into your ``diffpy.pdfmorph_env`` environment, we will also have to install dependencies ::
117117

118-
pip install -r https://raw.githubusercontent.com/diffpy/diffpy.pdfmorph/main/requirements/run.txt
118+
pip install -r https://raw.githubusercontent.com/diffpy/diffpy.pdfmorph/main/requirements/pip.txt
119119

120120
and then install the package ::
121121

@@ -160,7 +160,7 @@ Support and Contribute
160160

161161
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.pdfmorph. Please join the diffpy.pdfmorph users community by joining the Google group. The diffpy.pdfmorph project welcomes your expertise and enthusiasm!
162162

163-
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.pdfmorph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.pdfmorph/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
163+
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.pdfmorph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.pdfmorph/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
164164

165165
Feel free to fork the project and contribute. To install diffpy.pdfmorph
166166
in a development mode, with its sources being directly used by Python

‎TODO.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎TUTORIAL.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,5 +183,5 @@ Enjoy the software!
183183
Bug Reports
184184
-----------
185185

186-
Please enjoy using our software! If you come accross any bugs in the
186+
Please enjoy using our software! If you come accross any bugs in the
187187
application, please report them to [email protected]

‎doc/make.bat

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
@ECHO OFF
2-
3-
pushd %~dp0
4-
5-
REM Command file for Sphinx documentation
6-
7-
if "%SPHINXBUILD%" == "" (
8-
set SPHINXBUILD=sphinx-build
9-
)
10-
set SOURCEDIR=source
11-
set BUILDDIR=build
12-
set SPHINXPROJ=PackagingScientificPython
13-
14-
if "%1" == "" goto help
15-
16-
%SPHINXBUILD% >NUL 2>NUL
17-
if errorlevel 9009 (
18-
echo.
19-
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20-
echo.installed, then set the SPHINXBUILD environment variable to point
21-
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22-
echo.may add the Sphinx directory to PATH.
23-
echo.
24-
echo.If you don't have Sphinx installed, grab it from
25-
echo.http://sphinx-doc.org/
26-
exit /b 1
27-
)
28-
29-
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30-
goto end
31-
32-
:help
33-
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34-
35-
:end
36-
popd
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
set SPHINXPROJ=PackagingScientificPython
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20+
echo.installed, then set the SPHINXBUILD environment variable to point
21+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22+
echo.may add the Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.http://sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30+
goto end
31+
32+
:help
33+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34+
35+
:end
36+
popd

0 commit comments

Comments
 (0)