Metadata-Version: 2.1
Name: marisa-bindings
Version: 1.0.0
Summary: An unofficial project that provides Python bindings for the MARISA Trie, which is implemented in C++ using SWIG.
Author-email: Nobuyuki Sekimori <43375309+juno-rmks@users.noreply.github.com>
License: BSD 2-Clause License
        
        Copyright (c) 2024, Nobuyuki Sekimori
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Source Code, https://github.com/juno-rmks/marisa-bindings/
Project-URL: Issue Tracker, https://github.com/juno-rmks/marisa-bindings/issues/
Project-URL: Documentation, https://marisa-bindings.readthedocs.io/
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest-benchmark; extra == "test"
Requires-Dist: pytest-mock; extra == "test"
Provides-Extra: doc
Requires-Dist: Sphinx==5.3.0; extra == "doc"
Requires-Dist: sphinx-intl==2.1.0; extra == "doc"
Requires-Dist: sphinx-rtd-theme==1.2.0; extra == "doc"
Requires-Dist: myst-parser==1.0.0; extra == "doc"
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: marisa-bindings[doc,test]; extra == "dev"

# marisa-bindings

This is an unofficial project that provides Python bindings for the MARISA
Trie, which is implemented in C++ using SWIG.

## Installation

It is recommended to use a Python virtual environment to isolate dependencies
and avoid conflicts. To create and activate a virtual environment, run:

```console
% python -m venv .venv
% . .venv/bin/activate
```

### Installing from PyPI

To install `marisa-bindings` from PyPI into your virtual environment, run:

```console
% pip install marisa-bindings
```

### Installing from GitHub

Alternatively, if you prefer to install `marisa-bindings` directly from
the GitHub repository, use:

```console
% pip install git+https://github.com/juno-rmks/marisa-bindings.git
```

## Usage

To get started with `marisa_bindings`, import the `marisa` module, which
provides access to the MARISA trie functionalities:

```python
from marisa_bindings import marisa
```

For more detailed usage examples, refer to the [`marisa-bindings-sample.py`](marisa-bindings-sample.py) file.

## License

This project is licensed under the following terms:

- **Wrapped Code**: The wrapped code in this repository is licensed under
  the BSD 2-Clause License.
- **Original marisa-trie Code**: The original marisa-trie code is dual-licensed
  under the BSD 2-Clause License and the LGPL 2.1 or any later version.

For more details, please see the [LICENSE](LICENSE) file.

## Acknowledgments

Special thanks to the original authors of the MARISA library for their work.
