diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
| @@ -2,6 +2,32 @@ python-adblock | |||
| 2 | ========== | 2 | ========== |
| 3 | Python wrapper for Brave's adblocking library, which is written in Rust. | 3 | Python wrapper for Brave's adblocking library, which is written in Rust. |
| 4 | 4 | ||
| 5 | ### Building | ||
| 6 | |||
| 7 | ``` | ||
| 8 | maturin build --release | ||
| 9 | ``` | ||
| 10 | |||
| 11 | #### Build dependencies | ||
| 12 | |||
| 13 | | Build Dependency | Versions | Arch Linux | Url | | ||
| 14 | |------------------|----------|------------|-----| | ||
| 15 | | Python | `>=3.6` | `python3` | - | | ||
| 16 | | Rust | `>=1.45` | `rust` | - | | ||
| 17 | | Maturin | `*` | `maturin` | https://github.com/PyO3/maturin | | ||
| 18 | |||
| 19 | ### Developing | ||
| 20 | |||
| 21 | I use Poetry for development. To create and enter a virtual environment, do | ||
| 22 | ``` | ||
| 23 | poetry install | ||
| 24 | poetry shell | ||
| 25 | ``` | ||
| 26 | then, to install the `adblock` module into the virtual environment, do | ||
| 27 | ``` | ||
| 28 | maturin develop | ||
| 29 | ``` | ||
| 30 | |||
| 5 | ### Documentation | 31 | ### Documentation |
| 6 | 32 | ||
| 7 | Rust documentation for the latest `master` branch can be found at https://arnidagur.github.io/python-adblock/docs/adblock/index.html. | 33 | Rust documentation for the latest `master` branch can be found at https://arnidagur.github.io/python-adblock/docs/adblock/index.html. |
