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

use requirements.txt to formalize python deps #484

Merged
merged 4 commits into from
Jun 4, 2021

Conversation

jimexist
Copy link
Member

@jimexist jimexist commented Jun 3, 2021

Which issue does this PR close?

Closes #504.

Rationale for this change

What changes are included in this PR?

Are there any user-facing changes?

@codecov-commenter
Copy link

codecov-commenter commented Jun 3, 2021

Codecov Report

Merging #484 (dfef5af) into master (e713bc3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #484   +/-   ##
=======================================
  Coverage   75.95%   75.95%           
=======================================
  Files         154      154           
  Lines       26349    26349           
=======================================
  Hits        20014    20014           
  Misses       6335     6335           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e713bc3...dfef5af. Read the comment docs.

Copy link
Member

@jorgecarleitao jorgecarleitao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Great to see pip-tools being used :)

What do you think about adding to the README how to update test dependencies? Something like

To change test dependencies, change the requirements.in and run

# change requirements.in
pip install pip-tools
pip-compile --generate-hashes

To update dependencies, run

pip-compile update

More details here

@jimexist
Copy link
Member Author

jimexist commented Jun 3, 2021

Looks great. Great to see pip-tools being used :)

What do you think about adding to the README how to update test dependencies? Something like

To change test dependencies, change the requirements.in and run

change requirements.in

pip install pip-tools

pip-compile --generate-hashes

To update dependencies, run

pip-compile update

More details here

Personally I lean towards using poetry but that demands changes to publishing procedures as well - what do you think of that?

@jorgecarleitao
Copy link
Member

I do not quite follow: AFAIK both pip-tools and poetry are tools for Python applications, not Python libraries. For libraries, we only need to provide a setup.py / project.toml, which madurin does for us. I.e. the install_requires is here.

AFAI understand this PR is only concerned with the dependencies used for testing.

@jimexist
Copy link
Member Author

jimexist commented Jun 3, 2021

I do not quite follow: AFAIK both pip-tools and poetry are tools for Python applications, not Python libraries. For libraries, we only need to provide a setup.py / project.toml, which madurin does for us. I.e. the install_requires is here.

AFAI understand this PR is only concerned with the dependencies used for testing.

i meant the format for defining the project (the poetry way), but you are right this is probably non-related to this PR.

@jimexist
Copy link
Member Author

jimexist commented Jun 3, 2021

I do not quite follow: AFAIK both pip-tools and poetry are tools for Python applications, not Python libraries. For libraries, we only need to provide a setup.py / project.toml, which madurin does for us. I.e. the install_requires is here.

AFAI understand this PR is only concerned with the dependencies used for testing.

README.md updated, PTAL

@alamb alamb added the python label Jun 4, 2021
@alamb alamb merged commit e1a03a4 into apache:master Jun 4, 2021
@jimexist jimexist deleted the python-requirements branch June 4, 2021 17:12
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 this pull request may close these issues.

normalize the python dev environment requirements
4 participants