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

[JOSS] Suggestion: Streamline Python installation a bit more #248

Closed
adswa opened this issue Dec 22, 2023 · 2 comments · Fixed by #253
Closed

[JOSS] Suggestion: Streamline Python installation a bit more #248

adswa opened this issue Dec 22, 2023 · 2 comments · Fixed by #253
Assignees
Labels
enhancement New feature or request

Comments

@adswa
Copy link

adswa commented Dec 22, 2023

This is again a suggestion, and again refers to the Python part of the software.

There are dependency declarations and they are handled with automated package management solutions (check mark review checklist).
However, I noticed that the different installation instructions for Python result in deferentially useful sets of packages: A from-source installation gets me development relevant packages like pytest in addition to dependencies relevant for standard usage, a poetry-based installation gives me the Sphinx-dependencies necessary to build the docs in addition.

I would argue that standard users wouldn't need to run tests or build docs, but those inclined to contribute would. It would be cool if installations for both of these groups (standard users: just those dependencies that are relevant for using the tool; contributors: dependencies for testing and documentation building) would be easily possible, documented, and consistent across installation methods.

@CPernet CPernet added the enhancement New feature or request label Dec 26, 2023
@CPernet
Copy link
Contributor

CPernet commented Dec 26, 2023

sounds like a cool feature! @bendhouseart can do that I'm sure

@bendhouseart
Copy link
Contributor

Updating top level README.md and docs here -> #253

Preview of read the docs can be seen at the following link -> https://pet2bids--253.org.readthedocs.build/en/253/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants