[ENH] handle dependencies by pypi pyfar-gallery package
@ahms5 is already working on this.
Since Apr 28, 2026.
Assessment
This issue has not been assessed yet.
Description
I would suggest to define the dependencies in the pyproject.toml similar to other packages. Then we could just publish this as an pypi package with versions, and pypi can handle the dependencies for us.
The required requirements.txt for bilder could just include pyfar-gallery and the dependency hint at the beginning of each notebook would just be pip install pyfar-gallery.
an alternative name would be pyfar-examples, pyfar-gallery could be better as it is the same name used for readthedocs.
[project]
name = "pyfar-gallery"
version = "0.1.0"
description = "Dependencies for the pyfar example gallery."
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.11"
authors = [
{ name = "The pyfar developers", email = "[email protected]" },
]
dependencies = [
"numpy>=1.23.0",
"scipy>=1.5.0",
"matplotlib",
"pyfar>=0.8.0",
"sofar>=1.2.0",
"spharpy>=1.0.0",
"pyrato>=1.0.0",
"urllib3",
"soundfile>=0.11.0",
"sounddevice",
"deepdiff",
"ipykernel",
"ipympl",
"pooch",
"watermark",
"pytz",
]
[project.optional-dependencies]
deploy = [
"bump-my-version",
"wheel",
"twine",
]
tests = [
"watchdog",
"pytest<8.1.0",
"pytest-runner",
"pytest-cov",
"coverage",
"flake8",
"nbmake>=0.7.0",
"pre-commit",
]
docs = [
"Sphinx",
"pydata-sphinx-theme",
"autodocsumm>=0.2.14",
"nbsphinx",
"nbsphinx-link",
"sphinx-gallery",
"sphinx-design",
"sphinx-favicon",
"sphinx-copybutton",
]
dev = ["pyfar-gallery[deploy,tests,docs]"]
This is just an inital draft, we could also think of other usefull optional-dependencies.
This would solve the problem of double dependency handling discussed in #136
related to #101
If we decide to do that, I would like to implement it.
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 2
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pyfar/gallery
-
maintenance
Difficulty 2/5 Half a day Newbie friendliness 72/100
-
Add documentation on GitHub tokens and secrets to contribution guidelinesMay be free again @hoyer-a claimed this 45 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
AI Coding AgentsPossibly taken @hoyer-a claimed this 1 day ago. Open
-
Integrate Github Apps as a longterm replacement for Personal Access TokensMay be free again @hoyer-a claimed this 45 days ago, and no pull request is open. OpenCI enhancement
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kludex/python-multipart#375 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 3 days
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 11 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
FuRongJun-1999/dsh-memory#1000 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gcivil-nyu-org/team5-mon-fall26#154 ·
Maintainers usually reply within 1 day