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.

Sign up for GitHub

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

Jump to bottom

Introduce dependency scopes in setup.py #21

Closed
ZanSara opened this issue Mar 31, 2020 · 3 comments · Fixed by #27
Closed

Introduce dependency scopes in setup.py #21

ZanSara opened this issue Mar 31, 2020 · 3 comments · Fixed by #27
Assignees
@zkovari
Labels
maintenance Internal maintenance
Milestone
1.1.0

Comments

@ZanSara
Copy link
Contributor

ZanSara commented Mar 31, 2020 •
edited

Modern Python modules tend to offer a setup.py that separates dependencies by usage. For example, they provide:

  • core install (only necessary packages)
  • test install (the packages you need to run the tests properly)
  • doc install (the packages you need to build documentation)
  • dev install (extra packages for development)
  • aggregates install tags like all (install dependencies from all use-cases)
    and the possibility to define extra tags in case of need (like ci for extra packages needed on CI only, etc.)

I understand this package has not a lot of dependencies, but I believe it's a good practice to categorize them that way.

In addition, I'm not entirely sure what the requirements.txt is being used for. Currently installing this package with pip install -e . works just fine.
@ZanSara ZanSara mentioned this issue Mar 31, 2020
Closed
@zkovari
Copy link
Collaborator

zkovari commented Mar 31, 2020

yes I already planned to create such issue :) I agree with the above changes

@zkovari zkovari added the maintenance Internal maintenance label Mar 31, 2020
@zkovari zkovari self-assigned this Mar 31, 2020
@zkovari zkovari added this to the 1.1.0 milestone Mar 31, 2020
@zkovari
Copy link
Collaborator

zkovari commented Mar 31, 2020

I think requirements.txt could be removed. Indeed seems unnecessary.

@zkovari zkovari changed the title Improve a bit setup.py structure Introduce dependency scopes in setup.py Mar 31, 2020
zkovari added a commit that referenced this issue Mar 31, 2020
@zkovari
Introduce core, dev, test, doc dependency scopes in setup.py #21
086e89b
zkovari added a commit that referenced this issue Mar 31, 2020
@zkovari
Remove variable typing from setup.py to be compatible with Python 3.5 #…
42266ce 
…21
zkovari added a commit that referenced this issue Mar 31, 2020
@zkovari
Display each running test in GitHub action #21
f2d350f
@zkovari zkovari mentioned this issue Mar 31, 2020
Merged
@zkovari
Copy link
Collaborator

zkovari commented Mar 31, 2020

@ZanSara in #27, this is what you thought more or less?

zkovari added a commit that referenced this issue Apr 1, 2020
@zkovari
Introduce core, dev, test, doc dependency scopes in setup.py #21
b46a04f
zkovari added a commit that referenced this issue Apr 1, 2020
@zkovari
Remove variable typing from setup.py to be compatible with Python 3.5 #…
e3cf1e2 
…21
zkovari added a commit that referenced this issue Apr 1, 2020
@zkovari
Display each running test in GitHub action #21
8758fa8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zkovari zkovari

Labels
maintenance Internal maintenance
Projects
None yet
Milestone
1.1.0
Development

Successfully merging a pull request may close this issue.

#21 dependency scopes in setup.py addisonElliott/pyqt5ac
2 participants
@ZanSara @zkovari