Skip to content

Commit

Permalink
fix: 🐛 update docs, force release for macOS arm wheels
Browse files Browse the repository at this point in the history
  • Loading branch information
darvid committed Mar 8, 2024
1 parent e178849 commit 725a373
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 27 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
PKG_CONFIG_PATH="/opt/vectorscan/lib/pkgconfig:/opt/pcre/lib/pkgconfig:/usr/local/lib/pkgconfig:$PKG_CONFIG_PATH"
45 changes: 18 additions & 27 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# Hyperscan <small>for Python</small>

``python-hyperscan`` is an unofficial CPython extension for
Intel's [Hyperscan][1], the open source, high-performance multiple regex
matching library.
``python-hyperscan`` is a CPython extension for [Vectorscan][1], an
open source fork of [Hyperscan][2], Intel's open source
([prior to version 5.4][3]), high-performance multiple regex matching
library.

## Quickstart

### Building Hyperscan
### Building Vectorscan

See the [official documentation][3] for detailed installation
See the [official documentation][4] for detailed installation
instructions and dependencies.

The following should work for most use cases, once the prerequisite
dependencies have been installed:

```shell
$ git clone https://github.com/intel/hyperscan.git
$ mkdir -p hyperscan/build
$ cd hyperscan
$ git clone https://github.com/VectorCamp/vectorscan
$ mkdir -p vectorscan/build
$ cd vectorscan
$ # PCRE1 (8.xx series) is required for Chimera support
$ wget -qO- https://sourceforge.net/projects/pcre/files/pcre/8.45/pcre-8.45.tar.gz/download | tar xvz
$ git checkout v5.4.0
Expand All @@ -39,26 +40,16 @@ in the next Hyperscan release.

### Installing python-hyperscan

Installing via [pip][4] is recommended:
Installing via [pip][5] is recommended:

```shell
$ pip install hyperscan
pip install hyperscan
```

To build and install from source, using [Poetry][5]:

```shell
$ pip install poetry==1.4.2
$ git clone https://github.com/darvid/python-hyperscan.git
$ cd python-hyperscan
$ poetry install
```


[1]: https://01.org/hyperscan
[2]: https://github.com/pypa/manylinux
[3]: http://intel.github.io/hyperscan/dev-reference/getting_started.html#very-quick-start
[4]: https://pypi.org/project/pip/
[5]: https://poetry.eustace.io/
[6]: https://github.com/intel/hyperscan/issues/292
[7]: https://github.com/intel/hyperscan/issues/292#issuecomment-762635447
[1]: https://www.vectorcamp.gr/vectorscan/
[2]: https://www.hyperscan.io/
[3]: https://github.com/VectorCamp/vectorscan?tab=readme-ov-file#hyperscan-license-change-after-54
[4]: https://github.com/VectorCamp/vectorscan
[5]: https://pypi.org/project/pip/
[6]: https://poetry.eustace.io/
[7]: https://github.com/intel/hyperscan/issues/292

0 comments on commit 725a373

Please sign in to comment.