Skip to content

Refactor: Cookiecut (merge the other ones first) #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 11, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
git, codecov, cfgs, news dir, MANIFEST
  • Loading branch information
Tieqiong committed Jan 11, 2025
commit 81b3c03dfd444953de01714dd6b5518f34dd82c4
16 changes: 14 additions & 2 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
fixes:
- ".*/site-packages/::src/"
coverage:
status:
project: # more options at https://docs.codecov.com/docs/commit-status
default:
target: auto # use the coverage from the base commit, fail if coverage is lower
threshold: 0% # allow the coverage to drop by

comment:
layout: " diff, flags, files"
behavior: default
require_changes: false
require_base: false # [true :: must have a base report to post]
require_head: false # [true :: must have a head report to post]
hide_project_coverage: false # [true :: only show coverage on the git diff aka patch coverage]
9 changes: 0 additions & 9 deletions .codespell/ignore_words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,6 @@ socio-economic
;; Frobenius norm used in np.linalg.norm
fro

;; abbreviation for "structure"
struc

;; method name within JournalPanel class
onText

;; a method name within JournalPanel class
delt

;; structure file format
discus

Expand Down
22 changes: 0 additions & 22 deletions .coveragerc

This file was deleted.

5 changes: 0 additions & 5 deletions .gitarchive.cfg

This file was deleted.

7 changes: 0 additions & 7 deletions .gitattributes

This file was deleted.

98 changes: 69 additions & 29 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,52 +1,92 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
temp
develop-eggs
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
venv/
*.egg-info/
.installed.cfg
lib
lib64
tags
*.egg
bin/
temp/
tags/
errors.err

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt
MANIFEST

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.tox
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo
*.pot

# Mr Developer
.mr.developer.cfg
.project
.pydevproject
.settings

# SCons build files
.gdb_history
.sconf_temp/
.sconsign.dblite
config.log
/sconscript.local
/sconsvars.py

# version information
setup.cfg
/src/diffpy/*/version.cfg

# Django stuff:
*.log

# Sphinx documentation
docs/build/
docs/source/generated/

# pytest
.pytest_cache/

# PyBuilder
target/

# Editor files
# mac
.DS_Store
*~

# vim
*.swp
*.swo

# pycharm
.idea/

# VSCode
.vscode/

# Ipython Notebook
.ipynb_checkpoints
25 changes: 10 additions & 15 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
recursive-include src *
include SConstruct
include AUTHORS.txt LICENSE*.txt README.rst
recursive-exclude src *.pyc *.so
global-exclude .gitattributes .gitignore .gitarchive.cfg
global-exclude .DS_Store
graft src
graft tests
graft requirements

# Avoid user content in setup.cfg to make distribution reproducible.
exclude setup.cfg
include AUTHORS.rst LICENSE*.rst README.rst

# Exclude git-tracked files spuriously added by setuptools_scm
exclude .coveragerc
exclude .travis*
prune conda-recipe
prune devutils
prune doc
prune examples
# Exclude all bytecode files and __pycache__ directories
global-exclude *.py[cod] # Exclude all .pyc, .pyo, and .pyd files.
global-exclude .DS_Store # Exclude Mac filesystem artifacts.
global-exclude __pycache__ # Exclude Python cache directories.
global-exclude .git* # Exclude git files and directories.
global-exclude .idea # Exclude PyCharm project settings.
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: diffpy.pdfgui
name: diffpy.srreal
channels:
- conda-forge
dependencies:
Expand Down
23 changes: 23 additions & 0 deletions news/TEMPLATE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>