-
-
Notifications
You must be signed in to change notification settings - Fork 72
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
Clarify what a "project" is in documentation #12
Comments
Be nice if CLI followed
|
I'm using poetry on my projects and I'm getting Edit: from this comment on HN I'm guessing it's looking for a pyproject.yaml - https://news.ycombinator.com/item?id=20803525 however we have pyproject.toml on all our projects. |
@drcongo are you running it in the same location as your pyproject.yaml file? |
I've done a few things in the just release 1.1.0 release (https://timothycrosley.github.io/portray/CHANGELOG/#110-august-29) to try to address this:
Let me know if there is more that can be done, thanks for alerting me to this issue! Thanks! ~Timothy |
Thanks! In particular, note the link in the error message now, to https://timothycrosley.github.io/portray/TROUBLESHOOTING/#noprojectfound:
But I still think the top-level documentation for Portray, including the README.md, should define "project" in the Python context, since the term has a technical meeting of sorts here which is unclear, and can't be found via a straightforward google search. I guess it means something like "something to be packaged which has a pyproject.toml or setup.py file", or "the sort of thing that pypi lets you install". |
I get this traceback:
Clarification in the error message and in the documentation for what defines a "Python project" would help.
E.g. do you require that Poetry be used and/or that there be a pyproject.toml file?
The text was updated successfully, but these errors were encountered: