Setup for Development

Requirements

• Python 3.9+: Windows, MacOS, Linux
• Git

Clone this repository

git clone https://github.com/BURG3R5/matrix-encrypted-search.git
# Or git clone git@github.com:BURG3R5/matrix-encrypted-search.git
cd matrix-encrypted-search

Create and activate a virtual environment

MacOS and Linux

python -m venv .venv  # Or, if your system contains both Python 2 and 3, use `python3`
source .venv/bin/activate

Windows

python -m venv .venv
.venv\Scripts\activate

Install dependencies

pip install -r requirements.txt                    # Or, if your system contains both Python 2 and 3, use `pip3`
pip install -r requirements-dev.txt                # If you want to contribute to the library
pip install -r examples/requirements-examples.txt  # If you want to run the examples using matrix-nio

Install pre-commit hooks (for developers)

pre-commit install
pre-commit run --all-files

Download NLTK data

python -m nltk.downloader punkt stopwords

Run unittests

python -m unittest