Unified Diff: README.md
Issue 29338156:
Issue 3754 - Initial setup of the python-abp repo. (Closed)
Patch Set: Update ignore files, describe testing in README.md and fix a typo in tox.ini.
Created March 16, 2016, 3:56 p.m.
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« COPYING ('k')
|
abp/__init__.py » ('j')
|
setup.py » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| Index: README.md |
| =================================================================== |
| --- a/README.md |
| +++ b/README.md |
| @@ -0,0 +1,27 @@ |
| +# python-abp |
| + |
| +A library for working with Adblock Plus filterlists. |
|
Felix Dahlke
2016/03/17 09:25:32
Nit: "filter lists" should be two words.
|
| + |
| +## Testing |
| + |
| +Unit tests for `python-abp` are located in the `/tests` directory. |
| +[Pytest](http://pytest.org/) is used for quickly running the tests |
| +during development. |
| +[Tox](https://tox.readthedocs.org/) is used for testing in different |
| +environments (Python 2.7, Python 3.5 and PyPy) and code quality |
| +reporting. |
| + |
| +In order to execute the tests, first create and activate development |
| +virtualenv: |
| + |
| + $ python setup.py devenv |
| + $ . devenv/bin/activate |
| + |
| +After the development virtualenv is created use pytest for a quick |
| +test run: |
| + |
| + (devenv) $ py.test tests |
| + |
| +and tox for a comprehensive report: |
| + |
| + (devenv) $ tox |
