summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md47
1 files changed, 33 insertions, 14 deletions
diff --git a/README.md b/README.md
index 5889e57..2a3799b 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,48 @@
1python-adblock 1# python-adblock
2========== 2
3Python wrapper for Brave's adblocking library, which is written in Rust. 3Python wrapper for Brave's adblocking library, which is written in Rust.
4 4
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
17The `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
6 18
7``` 19```
8maturin build --release 20pip install .
9``` 21```
10 22
11#### Build dependencies 23from the root of this directory.
12 24
13| Build Dependency | Versions | Arch Linux | Url | 25#### Wheels
14|------------------|----------|------------|-----| 26
15| Python | `>=3.6` | `python3` | - | 27To create a wheel for this library, run the following command
16| Rust | `>=1.45` | `rust` | - | 28
17| Maturin | `>=0.10` | `maturin` | https://github.com/PyO3/maturin | 29```
30maturin build --release --no-sdist --out dist/
31```
32
33the result can be found in the `dist/` directory.
18 34
19### Developing 35### Developing
20 36
21I use Poetry for development. To create and enter a virtual environment, do 37I use Poetry for development. To create and enter a virtual environment, do
38
22``` 39```
23poetry install 40poetry install
24poetry shell 41poetry shell
25``` 42```
43
26then, to install the `adblock` module into the virtual environment, do 44then, to install the `adblock` module into the virtual environment, do
45
27``` 46```
28maturin develop 47maturin develop
29``` 48```
@@ -36,9 +55,9 @@ Rust documentation for the latest `master` branch can be found at https://arnida
36 55
37This project is licensed under either of 56This project is licensed under either of
38 57
39 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or 58- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
40 http://www.apache.org/licenses/LICENSE-2.0) 59 http://www.apache.org/licenses/LICENSE-2.0)
41 * MIT license ([LICENSE-MIT](LICENSE-MIT) or 60- MIT license ([LICENSE-MIT](LICENSE-MIT) or
42 http://opensource.org/licenses/MIT) 61 http://opensource.org/licenses/MIT)
43 62
44at your option. 63at your option.