Metadata-Version: 2.3
Name: susi-lib
Version: 1.2.2
Summary: Library for SuŠi organizers
Project-URL: Homepage, https://github.com/olilag/susi-lib
Author-email: Oliver Lago <oliver.oli.lago@gmail.com>
License-File: LICENSE
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: platformdirs
Description-Content-Type: text/markdown

# susi-lib

Python library for [SuŠi](https://susi.trojsten.sk) organizers.

## Overview

Provides classes and functions to more easily convert between
encodings used in puzzle hunting, to encapsulate regular expressions and to
find words that pass given criteria.

## Install

```bash
pip install susi-lib
```

## Usage

```python
# import everything, access in code susi_lib.[whatever]
import susi_lib
```

```python
from susi_lib import Finder, RegEx, create_regex, Selection
# types
from susi_lib.types import Braille, Morse, NumberSystems, Symbols, Semaphore
# functions
from susi_lib.functions import decode, encode, Encoding, is_palindrome
```

## Pre suši vedúcich

[Tu](./README-sk.md) je bližší návod pre vedúcich, ktorú chcú túto knižnicu používať.
