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 extras_require instead of dev-requirements.txt #318

Merged
merged 4 commits into from
Dec 29, 2017
Merged

Conversation

hynek
Copy link
Member

@hynek hynek commented Dec 27, 2017

It’s time for attrs to stop pretending we're an application. :)

I’m just not sure about the name; what is more common? test or tests?

@hynek hynek added this to the 17.4 milestone Dec 27, 2017
@codecov
Copy link

codecov bot commented Dec 27, 2017

Codecov Report

Merging #318 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #318   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           9      9           
  Lines         756    756           
  Branches      157    157           
=====================================
  Hits          756    756

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 3cffdfa...657dd64. Read the comment docs.

@Tinche
Copy link
Member

Tinche commented Dec 27, 2017

Someone contributed a change like this to pytest-asyncio, they called the extra 'testing'. pipenv uses '--dev'. Flit uses 'dev-requires'. Maybe standardize on 'dev'?

@hynek
Copy link
Member Author

hynek commented Dec 27, 2017

  • cryptography has test
  • Twisted has dev
  • pip has testing
  • Pyramid has testing
  • Flask has dev

I tend to like dev, but it doesn’t really reflect the fact, that it’s dependencies needed to run tests. It’s rather implied. 🤔

I’ve invited a public bike shed: https://twitter.com/hynek/status/946022597224955904 :)

@hynek
Copy link
Member Author

hynek commented Dec 27, 2017

JFTR, I remember why I disliked dev: sometimes it makes sense to install packages in a dev-mode: like structlog had forever with colorama, a web framework may have a debug toolbar etc.

That’s also stuff that belongs to pipenv’s dev, but it relates to the user’s concept of dev, not of the package.

Does it make any sense?

@Tinche
Copy link
Member

Tinche commented Dec 27, 2017

On the other hand, things like Sphinx and maybe something for benchmarking don't directly correspond to 'testing'. Sure Sphinx runs your doctests but its primary purpose is generating documentation. Linters also don't fall directly in the category of testing. Ideally your dev environment should contain everything we expect for development. If your contribution passes tests but crashes the docs, it's not going to get looked at.

@Tinche
Copy link
Member

Tinche commented Dec 27, 2017

On the third hand we might be bikeshedding this way too much. I'm basically OK with any of your Twitter poll options.

@Tinche
Copy link
Member

Tinche commented Dec 27, 2017

Also I see now we have a special docs-requirements.txt. Do we really need to be so granular with our deps?

@hynek
Copy link
Member Author

hynek commented Dec 27, 2017

The docs thing is for RTD mainly.

@hynek
Copy link
Member Author

hynek commented Dec 28, 2017

So my current inclination is to call it tests and docs to mirror the names of the directories. Maybe plus dev that contains both.

@Tinche Tinche merged commit c601faf into master Dec 29, 2017
@Tinche Tinche deleted the extra-deps branch December 29, 2017 15:11
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.

2 participants