-
Notifications
You must be signed in to change notification settings - Fork 19
Skpkg: update pyobjcryst #53
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
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
7340565
Update build script for skpkg standard
Tieqiong 12d13d8
modifpy windows build
Tieqiong 0aa8b8b
skpkg: update to skpkg standard.
Tieqiong a807844
fixing flake8:
Tieqiong 318e9a7
update scons test and documentations
Tieqiong 7780bc3
update find boost_python for linux
Tieqiong be15d50
pcmt on tests
Tieqiong c19f1b7
fix pytest fixture for 3.11
Tieqiong File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
--> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
name: Tests on PR | ||
|
||
on: | ||
pull_request: | ||
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 }} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this seems like it is likely an actual typo....is there are reason we want to escape it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sbillinge I decided not to correct them as it was inherited from
libobjcryst
. I can correct about half of this typos inpyobjcryst
but not all of them, and this will make usingpyobjcryst
different from directly usinglibobjcryst
...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, let's leave them like this for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo indeed - not sure how to safely correct this. The original C++ value is in an
enum
, don't know if I can safely have duplicate values so we don't break things.From the python interface it may be possible while retaining backwards compatibility ?