Issue 6835 - Add R support to python-abp

README.md

 # python-abp
 
 This repository contains a library for working with Adblock Plus filter lists
 and the script that is used for building Adblock Plus filter lists from the
 form in which they are authored into the format suitable for consumption by the
 adblocking software.
 
 ## Installation
 
 Prerequisites:
@@ skipping 141 matching lines @@
 ## Development
 
 When adding new functionality, add tests for it (preferably first). Code
 coverage (as measured by `tox -e qa`) should not decrease and the tests
 should pass in all Tox environments.
 
 All public functions, classes and methods should have docstrings compliant with
 [NumPy/SciPy documentation guide][5]. One exception is the constructors of
 classes that the user is not expected to instantiate (such as exceptions).
 
+
+## Using the library with R
+
+Clone the repo to you local machine. Then create a virtualenv and install 
+python abp there:
+
+        $ cd python-abp
+        $ virtualenv env
+        $ pip install --upgrade .
+
+Then import it with `reticulate` in R:
+
+        > library(reticulate)
+        > use_virtualenv("~/python-abp/env", required=TRUE)
+        > abp <- import("abp.filters.rpy")
+
+Now you can use the functions with `abp$functionname`, e.g. 
+`abp.line2dict("@@||g.doubleclick.net/pagead/$subdocument,domain=hon30.org")`
+
+
  [1]: https://adblockplus.org/filters#special-comments
  [2]: https://adblockplus.org/filters#options
  [3]: http://pytest.org/
  [4]: https://tox.readthedocs.org/
  [5]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt