coleifer / micawber

a small library for extracting rich content from urls
http://micawber.readthedocs.org/
MIT License
632 stars 91 forks source link

Define (test) requirements #82

Closed dvzrv closed 6 years ago

dvzrv commented 6 years ago

Hi! I'm currently trying to package this module for Arch Linux [community]. However, while doing so, I realized, that there is no definition of required dependencies. When grep'ing for imports, I see that tests definitely require beautifulsoup, because they import it (also they failed hard trying to execute without it being installed). There seems to be a conditional dependency on redis, django and flask. Can you please add them to a requirements.txt or add a Pipfile (and explain why they are needed), so I can add proper (optional, runtime and test) dependencies for the package and people will have an easier time using micawber? Thanks for your work!

coleifer commented 6 years ago

It requires either BeautifulSoup 3 or 4. Optional additional packages: redis (for a redis-backed cache). Micawber also comes with support for django/flask apps, but those should not be considered requirements.