1- python-adblock
2- ==========
1+ # python-adblock
2+
33Python wrapper for Brave's adblocking library, which is written in Rust.
44
5- ###Building
5+ ###Building from source
6+
7+ ####Build dependencies
8+
9+ | Build Dependency| Versions| Arch Linux| Url|
10+ | ----------------| --------| ----------| -------------------------------|
11+ | Python| ` >=3.6 ` | ` python ` | -|
12+ | Rust| ` >=1.45 ` | ` rust ` | -|
13+ | Maturin| ` >=0.10 ` | ` maturin ` | https://github.com/PyO3/maturin |
14+
15+ ####PEP 517
16+
17+ The` python-adblock ` library is[ PEP 517] ( https://www.python.org/dev/peps/pep-0517/ ) compatible, so you can build and install it from source, simply by running
618
719```
8- maturin build --release
20+ pip install .
921```
1022
11- #### Build dependencies
23+ from the root of this directory.
1224
13- | Build Dependency| Versions| Arch Linux| Url|
14- | ------------------| ----------| ------------| -----|
15- | Python| ` >=3.6 ` | ` python3 ` | -|
16- | Rust| ` >=1.45 ` | ` rust ` | -|
17- | Maturin| ` >=0.10 ` | ` maturin ` | https://github.com/PyO3/maturin |
25+ ####Wheels
26+
27+ To create a wheel for this library, run the following command
28+
29+ ```
30+ maturin build --release --no-sdist --out dist/
31+ ```
32+
33+ the result can be found in the` dist/ ` directory.
1834
1935###Developing
2036
2137I use Poetry for development. To create and enter a virtual environment, do
38+
2239```
2340poetry install
2441poetry shell
2542```
43+
2644then, to install the` adblock ` module into the virtual environment, do
45+
2746```
2847maturin develop
2948```
@@ -36,9 +55,9 @@ Rust documentation for the latest `master` branch can be found at https://arnida
3655
3756This project is licensed under either of
3857
39- * Apache License, Version 2.0, ([ LICENSE-APACHE] ( LICENSE-APACHE ) or
40- http://www.apache.org/licenses/LICENSE-2.0 )
41- * MIT license ([ LICENSE-MIT] ( LICENSE-MIT ) or
42- http://opensource.org/licenses/MIT )
58+ - Apache License, Version 2.0, ([ LICENSE-APACHE] ( LICENSE-APACHE ) or
59+ http://www.apache.org/licenses/LICENSE-2.0 )
60+ - MIT license ([ LICENSE-MIT] ( LICENSE-MIT ) or
61+ http://opensource.org/licenses/MIT )
4362
4463at your option.