Skip to content

Revise ADDING_PACKAGES.md for essdiffraction package #336

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
nvaytet merged 2 commits into from
Apr 15, 2026
Merged

Revise ADDING_PACKAGES.md for essdiffraction package #336

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e19a63b
Revise ADDING_PACKAGES.md for essdiffraction package
nvaytet Apr 15, 2026
50c0b91
Update ADDING_PACKAGES.md
nvaytet Apr 15, 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
28 changes: 25 additions & 3 deletions ADDING_PACKAGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ git clone git@github.com:scipp/essdiffraction.git /tmp/essdiffraction
cd /tmp/essdiffraction
git filter-repo --to-subdirectory-filter packages/essdiffraction --tag-rename ':essdiffraction/'
cd /path/to/ess
git checkout -b adding-essdiffraction-package
git remote add essdiffraction /tmp/essdiffraction
git fetch essdiffraction --tags
git merge essdiffraction/main --allow-unrelated-histories
Expand All @@ -25,10 +26,17 @@ git remote remove essdiffraction
tag_regex = "^essdiffraction/(?P<version>[vV]?\\d+(?:\\.\\d+)*(?:[._-]?\\w+)*)$"
git_describe_command = ["git", "describe", "--dirty", "--tags", "--long", "--match", "essdiffraction/*[0-9]*"]
```
- Add `docs` extra with deps from `requirements/docs.in` (minus base deps)
- Remove unnecessary configurations in the pyproject.toml file. i.e. `tools.codespell`.
- Add `docs` extra with deps from `requirements/docs.in` (minus base deps), e.g.:
```toml
docs = [
"autodoc-pydantic",
"ipykernel",
"ipython!=8.7.0",
]
```
- Remove unnecessary configurations in the pyproject.toml file. i.e. `[tool.codespell]`, `[tool.ruff]`, `[tool.ruff.lint]`, `[tool.ruff.format]`, etc
- Delete unnecessary files:
`tox.ini`, `requirements/`, `.github/`, `.pre-commit-config.yaml`, `MANIFEST.in`, `.gitignore`, `.python-version`.
`tox.ini`, `requirements/`, `.github/`, `.pre-commit-config.yaml`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `MANIFEST.in`, `.gitignore`, `.python-version`.

## 3. Add to `pixi.toml`

Expand All @@ -44,6 +52,9 @@ Docs feature:
```toml
[feature.docs-essdiffraction.pypi-dependencies]
essdiffraction = { path = "packages/essdiffraction", editable = true, extras = ["test", "docs"] }

[feature.docs-essdiffraction.tasks.docs-essdiffraction]
cmd = "python -m sphinx -v -b html -d packages/essdiffraction/.docs_doctrees packages/essdiffraction/docs packages/essdiffraction/html"
```

Environments (include features for workspace dependencies, e.g. `essreduce`):
Expand All @@ -62,4 +73,15 @@ Add a change filter and matrix entry. If the package depends on `essreduce`, inc

## 5. Run `pixi install` and commit

```bash
pixi install
git add -u
git commit -m "adding essdiffraction package"
```

## 6. Push the changes and tags with `essdiffraction` prefix.

```bash
git push origin adding-essdiffraction-package
git push origin --tags
```