Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
7340565
Update build script for skpkg standard
Tieqiong Jul 17, 2025
12d13d8
modifpy windows build
Tieqiong Jul 19, 2025
0aa8b8b
skpkg: update to skpkg standard.
Tieqiong Jul 19, 2025
a807844
fixing flake8:
Tieqiong Jul 19, 2025
318e9a7
update scons test and documentations
Tieqiong Jul 19, 2025
7780bc3
update find boost_python for linux
Tieqiong Jul 19, 2025
be15d50
pcmt on tests
Tieqiong Jul 19, 2025
c19f1b7
fix pytest fixture for 3.11
Tieqiong Jul 20, 2025
254e469
Merge pull request #53 from Tieqiong/skpkg
sbillinge Jul 20, 2025
9936c03
Remove nbstripout from pre-commit config
Tieqiong Jul 23, 2025
f385c5b
correct authors
Tieqiong Jul 23, 2025
cb8b015
try trigger workflows without .github on main
Tieqiong Jul 23, 2025
1ca5b1d
Merge pull request #56 from Tieqiong/ipynb
sbillinge Jul 23, 2025
ab212ac
wheel setup
Tieqiong Jul 28, 2025
7095b33
remove obsolete workflow file
Tieqiong Jul 28, 2025
9fc29ac
pcmt
Tieqiong Jul 28, 2025
a0b9aaa
Merge pull request #59 from Tieqiong/wheel
sbillinge Jul 28, 2025
26e2bd0
docs: fix examples documentation
ycexiao Jul 30, 2025
c9a4d39
docs: add submodules in `api/pyobjcryst.rst`
ycexiao Jul 30, 2025
dc7ad4d
update help message on scons
Tieqiong Jul 31, 2025
e9b35f7
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Jul 31, 2025
9b2831d
Merge pull request #65 from Tieqiong/help
sbillinge Aug 1, 2025
7974c7a
Merge pull request #64 from ycexiao/fix-docstring
sbillinge Aug 4, 2025
145f7f7
style: use pydata sphinx theme to render the docs
zmx27 Aug 4, 2025
7c7495d
fix: remove nbsphinx_link dependency
ycexiao Aug 4, 2025
67bcd54
chore: add lxml-html-clean as a dependency to requirements folder, fi…
zmx27 Aug 4, 2025
e5acfbd
chore: perform minor fixes according to feedback
zmx27 Aug 5, 2025
20799ab
Merge pull request #67 from zmx27/remove-nbsphinx-link-and-use-pydata
sbillinge Aug 5, 2025
c5057f5
remove fallback version
Tieqiong Aug 5, 2025
8495bdf
docs: remove the copied notebooks after building the documentation
ycexiao Aug 5, 2025
d3e151a
docs: remove documentation template and add QPA notebook in the docum…
ycexiao Aug 5, 2025
227a133
chore: fix pre-commit
ycexiao Aug 5, 2025
bb29999
Merge pull request #68 from Tieqiong/fbv
sbillinge Aug 5, 2025
02b4b9a
Merge pull request #69 from ycexiao/rm-copied-notebook
sbillinge Aug 5, 2025
8f6a5da
Merge pull request #70 from ycexiao/remove-template
sbillinge Aug 5, 2025
5b2712e
docs: remove skpkg template files, remove mention of diffpy-cmi in in…
zmx27 Aug 5, 2025
3896eda
fix: modify project script in pyproject.toml
zmx27 Aug 5, 2025
5812033
docs: update readme, delete project.scripts
zmx27 Aug 6, 2025
2e22303
Merge pull request #71 from zmx27/modify-docs
sbillinge Aug 6, 2025
32f71ac
docs: synchronize readme with old one
sbillinge Aug 6, 2025
9f63032
docs: move getting started up in readme
sbillinge Aug 6, 2025
923d6da
Merge pull request #72 from sbillinge/readme
sbillinge Aug 6, 2025
4fba18d
docs: correctly create link to QPA notebook in index.rst
zmx27 Aug 7, 2025
d7dbe0a
chore: add news file
zmx27 Aug 7, 2025
2e2669c
Merge pull request #73 from zmx27/link-QPA
sbillinge Aug 7, 2025
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
14 changes: 14 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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]
2 changes: 2 additions & 0 deletions .codespell/ignore_lines.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
;; Please include filenames and explanations for each ignored line.
;; See https://docs.openverse.org/meta/codespell.html for docs.
17 changes: 17 additions & 0 deletions .codespell/ignore_words.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
;; Please include explanations for each ignored word (lowercase).
;; See https://docs.openverse.org/meta/codespell.html for docs.

;; ORTHORHOMBIC
ORTHOROMBIC

;; src/pyobjcryst/tests/testmolecule.py
;; variable name, abbreviation for "a bottom"
abot

;; src/extensions/diffractiondatasinglecrystal_ext.cpp:148
;; abbreviation for "register"
regist

;; src/pyobjcryst/crystal.py:548
;; alabelstyle parameter
inFront
22 changes: 0 additions & 22 deletions .coveragerc

This file was deleted.

14 changes: 14 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# As of now, flake8 does not natively support configuration via pyproject.toml
# https://github.com/microsoft/vscode-flake8/issues/135
[flake8]
exclude =
.git,
__pycache__,
build,
dist,
doc/source/conf.py
# huge loops in crystal.py
max-line-length = 99
# Ignore some style 'errors' produced while formatting by 'black'
# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings
extend-ignore = E203
5 changes: 0 additions & 5 deletions .gitarchive.cfg

This file was deleted.

7 changes: 0 additions & 7 deletions .gitattributes

This file was deleted.

16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Bug Report or Feature Request
about: Report a bug or suggest a new feature!
title: ""
labels: ""
assignees: ""
---

### Problem

<!--
For a bug report, please copy and paste any error messages from the application or command-line here.
For a feature request, please state how the new functionality could benefit the community.
-->

### Proposed solution
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/release_checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Release
about: Checklist and communication channel for PyPI and GitHub release
title: "Ready for <version-number> PyPI/GitHub release"
labels: "release"
assignees: ""
---

### PyPI/GitHub rc-release preparation checklist:

- [ ] All PRs/issues attached to the release are merged.
- [ ] All the badges on the README are passing.
- [ ] License information is verified as correct. If you are unsure, please comment below.
- [ ] Locally rendered documentation contains all appropriate pages, including API references (check no modules are
missing), tutorials, and other human-written text is up-to-date with any changes in the code.
- [ ] Installation instructions in the README, documentation, and the website are updated.
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version.
- [ ] Grammar and writing quality are checked (no typos).
- [ ] Install `pip install build twine`, run `python -m build` and `twine check dist/*` to ensure that the package can be built and is correctly formatted for PyPI release.

Please tag the maintainer (e.g., @username) in the comment here when you are ready for the PyPI/GitHub release. Include any additional comments necessary, such as version information and details about the pre-release here:

### PyPI/GitHub full-release preparation checklist:

- [ ] Create a new conda environment and install the rc from PyPI (`pip install <package-name>==??`)
- [ ] License information on PyPI is correct.
- [ ] Docs are deployed successfully to `https://<github-username-or-orgname>/<package-name>`.
- [ ] Successfully run all tests, tutorial examples or do functional testing.

Please let the maintainer know that all checks are done and the package is ready for full release.

### conda-forge release preparation checklist:

<!-- After the maintainer releases the PyPI package, please check the following when creating a PR for conda-forge release.-->

- [ ] Ensure that the full release has appeared on PyPI successfully.
- [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock.
- [ ] Close any open issues on the feedstock. Reach out to the maintainer if you have questions.
- [ ] Tag the maintainer for conda-forge release.

### Post-release checklist

<!-- Before closing this issue, please complete the following: -->

- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### What problem does this PR address?

<!-- Provide a brief overview and link to the issue. Attach outputs, including screenshots (before/after), if helpful for the reviewer. -->

### What should the reviewer(s) do?

<!-- Merge the code, provide feedback, initiate a discussion, etc. -->

<!--
Use the following checklist items when applicable (select only what applies):
- [ ] This PR introduces a public-facing change (e.g., figures, CLI input/output, API).
- [ ] Documentation (e.g., tutorials, examples, README) has been updated.
- [ ] A tracking issue or plan to update documentation exists.
- [ ] This PR affects internal functionality only (no user-facing change).
-->
18 changes: 18 additions & 0 deletions .github/workflows/build-wheel-release-upload.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Release (GitHub/PyPI) and Deploy Docs

on:
workflow_dispatch:
push:
tags:
- "*" # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml

jobs:
release:
uses: scikit-package/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
with:
project: pyobjcryst
c_extension: true
maintainer_GITHUB_username: sbillinge
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
12 changes: 12 additions & 0 deletions .github/workflows/check-news-item.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Check for News

on:
pull_request_target:
branches:
- main

jobs:
check-news-item:
uses: scikit-package/release-scripts/.github/workflows/_check-news-item.yml@v0
with:
project: pyobjcryst
21 changes: 21 additions & 0 deletions .github/workflows/matrix-and-codecov-on-merge-to-main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: CI

on:
push:
branches:
- main
release:
types:
- prereleased
- published
workflow_dispatch:

jobs:
matrix-coverage:
uses: scikit-package/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
with:
project: pyobjcryst
c_extension: true
headless: false
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
12 changes: 12 additions & 0 deletions .github/workflows/publish-docs-on-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Deploy Documentation on Release

on:
workflow_dispatch:

jobs:
docs:
uses: scikit-package/release-scripts/.github/workflows/_publish-docs-on-release.yml@v0
with:
project: pyobjcryst
c_extension: true
headless: false
17 changes: 17 additions & 0 deletions .github/workflows/tests-on-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Tests on PR

on:
pull_request:
branches:
- "**"
workflow_dispatch:

jobs:
tests-on-pr:
uses: scikit-package/release-scripts/.github/workflows/_tests-on-pr.yml@v0
with:
project: pyobjcryst
c_extension: true
headless: false
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
Loading
Loading