Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: README.rst

Issue 29989581: Noissue - Update virtualenv instructions (Closed) Base URL: https://hg.adblockplus.org/python-abp/
Patch Set: Created Jan. 24, 2019, 11:36 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 python-abp 1 python-abp
2 ========== 2 ==========
3 3
4 This repository contains a library for working with Adblock Plus filter lists, 4 This repository contains a library for working with Adblock Plus filter lists,
5 a script for rendering diffs between filter lists, and the script that is used 5 a script for rendering diffs between filter lists, and the script that is used
6 for building Adblock Plus filter lists from the form in which they are authored 6 for building Adblock Plus filter lists from the form in which they are authored
7 into the format suitable for consumption by the adblocking software (aka 7 into the format suitable for consumption by the adblocking software (aka
8 rendering). 8 rendering).
9 9
10 .. contents:: 10 .. contents::
(...skipping 193 matching lines...) Expand 10 before | Expand all | Expand 10 after
204 204
205 All public functions, classes and methods should have docstrings compliant with 205 All public functions, classes and methods should have docstrings compliant with
206 `NumPy/SciPy documentation guide <https://github.com/numpy/numpy/blob/master/doc /HOWTO_DOCUMENT.rst.txt>`_. 206 `NumPy/SciPy documentation guide <https://github.com/numpy/numpy/blob/master/doc /HOWTO_DOCUMENT.rst.txt>`_.
207 One exception is the constructors of classes that the user is not expected to 207 One exception is the constructors of classes that the user is not expected to
208 instantiate (such as exceptions). 208 instantiate (such as exceptions).
209 209
210 210
211 Using the library with R 211 Using the library with R
212 ------------------------ 212 ------------------------
213 213
214 Clone the repo to your local machine. Then create a virtualenv and install 214 Clone the repo to your local machine. Then create a virtualenv and install
Vasily Kuznetsov 2019/01/25 12:09:50 Since we have published the module on PyPI, we now
rhowell 2019/01/25 23:49:00 Done.
215 python-abp there:: 215 python-abp there::
216 216
217 $ cd python-abp 217 $ cd python-abp
218 $ virtualenv env 218 $ virtualenv venv
219 $ source venv/bin/activate
Vasily Kuznetsov 2019/01/25 12:09:50 Since we don't need the virtualenv to be activated
rhowell 2019/01/25 23:49:00 Done.
219 $ pip install --upgrade . 220 $ pip install --upgrade .
220 221
221 222
222 Then import it with ``reticulate`` in R: 223 Then import it with ``reticulate`` in R:
223 224
224 .. code-block:: R 225 .. code-block:: R
225 226
226 > library(reticulate) 227 > library(reticulate)
227 > use_virtualenv("~/python-abp/env", required=TRUE) 228 > use_virtualenv("~/python-abp/env", required=TRUE)
228 > abp <- import("abp.filters.rpy") 229 > abp <- import("abp.filters.rpy")
229 230
230 Now you can use the functions with ``abp$functionname``, e.g. 231 Now you can use the functions with ``abp$functionname``, e.g.
231 ``abp.line2dict("@@||g.doubleclick.net/pagead/$subdocument,domain=hon30.org")``. 232 ``abp.line2dict("@@||g.doubleclick.net/pagead/$subdocument,domain=hon30.org")``.
233
234
235 When you are finished, deactivate the virtualenv and delete it::
Vasily Kuznetsov 2019/01/25 12:09:50 If you agree with the suggestion above about not a
rhowell 2019/01/25 23:49:00 Done.
236
237 $ deactivate
238 $ rm -r venv/
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld