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

Missing requirements.txt #11

Closed
aahnik opened this issue May 15, 2021 · 6 comments · Fixed by #15
Closed

Missing requirements.txt #11

aahnik opened this issue May 15, 2021 · 6 comments · Fixed by #15

Comments

@aahnik
Copy link
Contributor

aahnik commented May 15, 2021

notion-sdk-py/setup.py

Lines 20 to 21 in 93f3ca9

install_requires=[
"httpx >= 0.15.0, < 0.18.0",

Install requires httpx, so I think, the project requirements.txt for that.

The best point for using poetry is that we don't need to write the deps twice. Once in requirements.txt, and once in setup.py.

@aahnik
Copy link
Contributor Author

aahnik commented May 15, 2021

requirements.txt is required for GitHub to generate dependency graphs. Github dependabot can alert us of any critical security updates in any package we depend on.

@ramnes
Copy link
Owner

ramnes commented May 15, 2021

IIRC dependabot can already parse setup.py. GitHub dependency graph is not really important to me, and I'd rather not duplicate the dependencies for this sole benefit. Although maybe it's smart enough to support a "fake" requirements.txt containing only something like -e .?

@aahnik
Copy link
Contributor Author

aahnik commented May 15, 2021

If requirements.txt is there, then the developer can do

pip install -r requirements.txt

For the end-user, who will pip install notion-client , this does not matter. But for people who will clone this repo, create a virtual env, and start developing, they need to need to manually install all required packages required by the notion-client.

Currently notion-client only depends on httpx, (so i need to pip install httpx) but in the future, as we provide more features, we may need other dependencies, then pip install x y z may become cumbersome.

It will be great, if a contributing guidelines is written, for new developers who want to contribute to this repo.

@ramnes
Copy link
Owner

ramnes commented May 15, 2021

Yeah, I do agree that a requirements.txt file makes contributing easier by respecting people habits. :) What I don't want is to duplicate the list of dependencies, hence the -e . suggestion, which I think would make everyone happy.

@aahnik
Copy link
Contributor Author

aahnik commented May 15, 2021

yes, that's right. But once, editable installs are available for pyproject.toml, I think, we should move to poetry.

@ramnes
Copy link
Owner

ramnes commented May 15, 2021

Yeah maybe, let's discuss it again when that happens. Thanks for your contribution!

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

Successfully merging a pull request may close this issue.

2 participants