blob: 5889e57bc311d800687b80add8a6e8230fc26e33 (
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
|
python-adblock
==========
Python wrapper for Brave's adblocking library, which is written in Rust.
### Building
```
maturin build --release
```
#### Build dependencies
| Build Dependency | Versions | Arch Linux | Url |
|------------------|----------|------------|-----|
| Python | `>=3.6` | `python3` | - |
| Rust | `>=1.45` | `rust` | - |
| Maturin | `>=0.10` | `maturin` | https://github.com/PyO3/maturin |
### 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.
|
