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

DRY: Only define dependencies in install_requires #306

Merged
merged 4 commits into from
Oct 20, 2019

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Oct 19, 2019

Instead of defining the installation dependencies in .travis.yml, tox.ini and setup.py, only define the in setup.py. requirements.txt is not needed.

tox.ini does not need to duplicate them: it will run python setup.py install anyway, and install them from setup.py's install_requires.

Let's also use tox on Travis CI, no need to list them there either.

Copy link
Member

@pietermarsman pietermarsman left a comment

Choose a reason for hiding this comment

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

Looking good.

How would you set up the dev environment? It would be nice if we could use a command that only installs the dependencies of the setup.py file, but not pdfminer.six itself.

setup.py Outdated Show resolved Hide resolved
@pietermarsman
Copy link
Member

There are also depencies for development: tox and nose. These can be added using extra_requires.

How would you install the packages for development? The best way I can find is pip install -e .[dev] (assuming there is an extra_requires section called "dev"). It installs the package in editable mode allowing to update the source without reinstalling. And it installs the development packages.

And a last request for this PR is to add some documentation. I think the CONTRIBUTING.md file should have a small section on setting up a development environment and the commands for cloning the repo and installing the dev dependencies.

@pietermarsman pietermarsman added the type: development Related to the development process for maintainers label Oct 20, 2019
@hugovk
Copy link
Contributor Author

hugovk commented Oct 20, 2019

Done and done!

@pietermarsman pietermarsman merged commit 12bba5b into pdfminer:develop Oct 20, 2019
@hugovk hugovk deleted the dry-dependencies branch October 20, 2019 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: development Related to the development process for maintainers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants