blob: 2a3799be01faeb083b1713c1f6bdda1c5ea06c9c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# python-adblock
Python wrapper for Brave's adblocking library, which is written in Rust.
### Building from source
#### Build dependencies
| Build Dependency | Versions | Arch Linux | Url |
| ---------------- | -------- | ---------- | ------------------------------- |
| Python | `>=3.6` | `python` | - |
| Rust | `>=1.45` | `rust` | - |
| Maturin | `>=0.10` | `maturin` | https://github.com/PyO3/maturin |
#### PEP 517
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
```
pip install .
```
from the root of this directory.
#### Wheels
To create a wheel for this library, run the following command
```
maturin build --release --no-sdist --out dist/
```
the result can be found in the `dist/` directory.
### Developing
I use Poetry for development. To create and enter a virtual environment, do
```
poetry install
poetry shell
```
then, to install the `adblock` module into the virtual environment, do
```
maturin develop
```
### Documentation
Rust documentation for the latest `master` branch can be found at https://arnidagur.github.io/python-adblock/docs/adblock/index.html.
### License
This project is licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
at your option.
|
