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

Support pyproject.toml for Python requirements #17

Closed
waltsims opened this issue Nov 19, 2022 · 2 comments · Fixed by #21
Closed

Support pyproject.toml for Python requirements #17

waltsims opened this issue Nov 19, 2022 · 2 comments · Fixed by #21

Comments

@waltsims
Copy link

After migrating our project from requirement files to pyproject.toml, out sphinx build has broken.

Current behavior is sphinx-notes pages fails if requirements are in pyproject.toml file.

Feature request would be to:

Add support for pyproject.toml requirements specification.

e.g. pip install '.[docs]'

@SilverRainZ
Copy link
Member

Hello waltsims, thanks for your contribution.

I'm not very familiar with poetry so I have a few questions.

  • What is the usage pip install '.[docs]' called? I can't find it from pip install --help.
  • is docs a conventional name? Maybe we can make it the default?

@SilverRainZ SilverRainZ linked a pull request Nov 20, 2022 that will close this issue
@waltsims
Copy link
Author

Hi @SilverRainZ,

The usage of the pyproject.toml file is described extensively in PEP 621 and can be found under the key-words dependencies and optional-dependencies.
I don't know if there are any conventions on optional dependency naming so I cannot answer weather or not '.[docs]' should be a default value. I can say though that pip install . installs the base dependencies, which is why I selected it as the default value for my PR.

I have my k-wave-python project currently successfully using my fork of your repository to build the project docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants