semvec/pypi-packages huggingface dataset:
wagtail-redisearch 0.4.0
A Django app to use RediSearch as a search backend in Wagtail.
License: MIT
Requires Python: >=3.7,<4.0

[![!PyPi version](https://img.shields.io/pypi/v/wagtail-redisearch.svg)](https://pypi.org/project/wagtail-redisearch/)
[![!Python versions](https://img.shields.io/pypi/pyversions/wagtail-redisearch.svg)](https://pypi.org/project/wagtail-redisearch/)
[![!CI/CD status](https://github.com/TommasoAmici/wagtail-redisearch/actions/workflows/build.yaml/badge.svg)](https://github.com/TommasoAmici/wagtail-redisearch/actions/workflows/build.yaml)
[![!Code coverage status](https://codecov.io/gh/TommasoAmici/wagtail-redisearch/branch/main/graph/badge.svg)](https://codecov.io/gh/TommasoAmici/wagtail-redisearch)
[![!Formatted with Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# wagtail-redisearch

A Django app to use [RediSearch](https://redis.com/modules/redis-search/) as a search
backend in Wagtail.

## Requirements

- Django >= 3.2
- Wagtail >= 2.15
- RediSearch v2

## Usage

Install [`wagtail-redisearch`](https://pypi.org/project/wagtail-redisearch/) from PyPi.

In your `settings.py` add `"wagtail_redisearch"` to `INSTALLED_APPS` and configure your search backend as follows:

```py
INSTALLED_APPS = [
  "wagtail_redisearch",
  ...
]

WAGTAILSEARCH_BACKENDS = {
    "default": {
        "BACKEND": "wagtail_redisearch",
        # optional parameters
        "INDEX": "custom-index-name", # default: "wagtail"
        "HOST": "127.0.0.1",
        "PORT": 6379,
        # you can add any option here to be used when initializing
        # a Redis client with redis-py.
        # e.g.
        "retry_on_error": True
    }
}
```

For more information about what options you can pass to the Redis client, look at the [official documentation](https://redis.readthedocs.io/en/stable/connections.html#generic-client).

`wagtail-redisearch` implements the interfaces described in [Backends Rolling your own](https://docs.wagtail.org/en/stable/topics/search/backends.html#rolling-your-own), thus usage in Wagtail requires no special adjustment.

To configure search on your models, follow the [official Wagtail documentation](https://docs.wagtail.org/en/stable/topics/search/index.html).

## Contributing

To contribute to this project you'll need RediSearch installed and `poetry`.

```sh
# install dependencies
poetry install

# run tests
make test

# run tests with tox
make test-all

# to run a minimal Wagtail application to test things out
make run
```
fxp 0.1.0
VST2.x plugin FXP preset parser
License: MIT
Requires Python: >=3.6

<!-- BADGES -->
<table>
  <tr>
    <th>ci</th>
    <td>
      <a>
        <img alt="Tests" src="https://img.shields.io/github/workflow/status/demberto/fxp/tests?label=tests"/>
      </a>
      <a>
        <img alt="Build" src="https://img.shields.io/github/workflow/status/demberto/fxp/publish"/>
      </a>
      <a href="https://fxp.rtfd.io/">
        <img alt="Docs" src="https://readthedocs.org/projects/fxp/badge/?version=latest"/>
      </a>
    </td>
  </tr>
  <tr>
    <th>pypi</th>
    <td>
      <a href="https://github.com/demberto/fxp/releases">
        <img alt="Version" src="https://img.shields.io/pypi/v/fxp"/>
      </a>
      <a href="https://github.com/demberto/fxp/blob/master/LICENSE">
        <img alt="License" src="https://img.shields.io/pypi/l/fxp"/>
      </a>
      <a>
        <img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/fxp"/>
      </a>
    </td>
  </tr>
  <tr>
    <th>qa</th>
    <td>
      <a href="https://github.com/PyCQA/bandit">
        <img alt="security: bandit" src="https://img.shields.io/badge/security-bandit-yellow.svg"/>
      </a>
      <a href="https://github.com/python/mypy">
        <img alt="mypy: checked" src="https://img.shields.io/badge/mypy-checked-blue.svg"/>
      </a>
      <a href="https://github.com/psf/black">
        <img alt="code style: black" src="https://img.shields.io/badge/code%20style-black-black.svg"/>
      </a>
    </td>
  </tr>
</table>

# fxp

> VST2.x plugin FXP preset parser.

## ⏬ Installation

- Via `pip` (**RECOMMENDED**, easiest, fastest):

  fxp requires Python 3.6+

  ```
  pip install fxp
  ```

*OR*

- Via Github Releases

  1.  [Download](https://github.com/demberto/fxp/releases) the latest release.

  2.  Install it via `pip`:

      ```
      pip install fxp-0.1.0-py3-none-any.whl
      ```

*OR*

- Via cloning the repo:

  1.  Clone this repo

      ```
      git clone https://github.com/demberto/fxp
      ```

  2.  Navigate to the directory

      ```
      cd fxp
      ```

  3.  Install it via `pip` in editable mode:

      ```
      pip install -e .
      ```

## ✨ Getting Started

```Python
>>> import fxp
>>> preset = fxp.FXP("path/to/preset.fxp")
>>> preset.plugin_id
"XfsX"
>>> preset.name
"LD Saw Bass"
>>> preset.is_opaque()
True
```

## 🤝 Contributing

All contributions are welcome and acknowledged.
Please take a look at the [contributor's guide][contributor-guide]

## 📧 Contact

Email: demberto@protonmail.com

## 🙏 Acknowledgements

- `pluginterfaces/vstfxstore.h` from the VST2 SDK.

## © License

The code in this project is licensed under the MIT License.

<!-- LINKS -->
[contributor-guide]: https://github.com/demberto/fxp/blob/master/CONTRIBUTING.md