Skip to content
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

Recut - update REAMDE, remove unnecessary files, use GitHub release workflowRecut release #127

Merged
merged 11 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
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
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/release_checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Release
about: Checklist and communication channel for PyPI and GitHub release
title: "Ready for <version-number> PyPI/GitHub release"
labels: "release"
assignees: ""
---

### Release checklist for GitHub contributors

- [ ] 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 on the website (e.g., diffpy.org) are updated and
tested
- [ ] Successfully run any tutorial examples or do functional testing in some other way.
- [ ] Grammar and writing quality have been checked (no typos).

Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as
version information and details about the pre-release.
16 changes: 16 additions & 0 deletions .github/workflows/build-wheel-release-upload.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Release (GitHub/PyPI)

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: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
with:
project: diffpy.utils
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
17 changes: 12 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,18 @@ To add "conda-forge" to the conda channels, run the following in a terminal. ::
We want to install our packages in a suitable conda environment.
The following creates and activates a new environment named ``diffpy.utils_env`` ::

conda create -n diffpy.utils_env python=3
conda create -n diffpy.utils_env diffpy.utils
conda activate diffpy.utils_env

Then, to fully install ``diffpy.utils`` in our active environment, run ::
To confirm that the installation was successful, type ::

conda install diffpy.utils
python -c "import diffpy.utils; print(diffpy.utils.__version__)"

Another option is to use ``pip`` to download and install the latest release from
The output should print the latest version displayed on the badges above.

If the above does not work, you can use ``pip`` to download and install the latest release from
`Python Package Index <https://pypi.python.org>`_.
To install using ``pip`` into your ``diffpy.utils_env`` environment type ::
To install using ``pip`` into your ``diffpy.utils_env`` environment, type ::

pip install diffpy.utils

Expand All @@ -99,6 +101,11 @@ and run the following ::

pip install .

Getting Started
---------------

You may consult our `online documentation <https://diffpy.github.io/diffpy.utils>`_ for tutorials and API references.

Support and Contribute
----------------------

Expand Down
23 changes: 23 additions & 0 deletions news/recut.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:**

* Recut to group's package standard, fix installation, add GitHub release workflow

**Security:**

* <news item>
10 changes: 10 additions & 0 deletions tests/test_version.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
"""Unit tests for __version__.py
"""

import diffpy.utils


def test_package_version():
"""Ensure the package version is defined and not set to the initial placeholder."""
assert hasattr(diffpy.utils, "__version__")
assert diffpy.utils.__version__ != "0.0.0"