Skip to content

docs: update README #15

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.

Sign up for GitHub

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
sbillinge merged 3 commits into from
Apr 19, 2026
+31 −36
Merged

docs: update README #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8ffd7b
docs: use `python=3.13` for installation and mention the `runmacro` a…
ycexiao Apr 18, 2026
ff4856d
chore: also support `diffpy.apps` entry point
ycexiao Apr 18, 2026
0a48d18
chore: add news
ycexiao Apr 18, 2026
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
7 changes: 4 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@
.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
:target: https://github.com/diffpy/diffpy.apps/issues

User applications to help with tasks using diffpy packages
User applications to help with tasks using diffpy packages. Currently it
contains

* LONGER DESCRIPTION HERE
- `runmacro`: A runner for DiffPy macro files.

For more information about the diffpy.apps library, please consult our `online documentation <https://diffpy.github.io/diffpy.apps>`_.

Expand All @@ -63,7 +64,7 @@ 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.apps_env`` ::

conda create -n diffpy.apps_env diffpy.apps
conda create -n diffpy.apps_env diffpy.apps python=3.13
conda activate diffpy.apps_env

The output should print the latest version displayed on the badges above.
Expand Down
24 changes: 24 additions & 0 deletions news/update-readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
**Added:**

* Also add ``diffpy.apps`` as an entry point.
Copy link
Copy Markdown
Contributor Author

@ycexiao ycexiao Apr 18, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The package name(diffpy.apps) and the CLI app(diffpy.app) name are easy to confuse. We use diffpy.app because each time only one app is invoked.

Also add diffpy.apps as an entry point for user's convenience when they didn't notice the difference between the package name and the entry point.

* Add ``runmacro`` in the ``README``.

**Changed:**

* Use ``python=3.13`` as default before ``python=3.14`` is supported by ``diffpy.cmi``.

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ exclude = [] # exclude packages matching these glob patterns (empty by default)
namespaces = false # to disable scanning PEP 420 namespaces (true by default)

[project.scripts]
"diffpy.apps" = "diffpy.apps.apps:main"
"diffpy.app" = "diffpy.apps.apps:main"

[tool.setuptools.dynamic]
Expand Down
4 changes: 2 additions & 2 deletions src/diffpy/apps/apps.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ def main():

parser.add_argument(
"--version",
action="store_true",
help="Show the program's version number and exit",
action="version",
version=f"diffpy.apps {__version__}",
)
apps_parsers = parser.add_subparsers(
title="Available applications",
Expand Down
31 changes: 0 additions & 31 deletions src/diffpy/apps/functions.py
View file
Open in desktop

This file was deleted.

Loading