Metadata-Version: 2.1
Name: lute3
Version: 3.3.0a2
Summary: Learning Using Texts
Author-email: Jeff Zohrab <jzohrab@gmail.com>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: Flask-SQLAlchemy>=3.1.1,<4
Requires-Dist: Flask-WTF>=1.2.1,<2
Requires-Dist: natto-py>=1.0.1,<2
Requires-Dist: jaconv>=0.3.4,<1
Requires-Dist: platformdirs>=3.10.0,<4
Requires-Dist: requests>=2.31.0,<3
Requires-Dist: beautifulsoup4>=4.12.2,<5
Requires-Dist: PyYAML>=6.0.1,<7
Requires-Dist: toml>=0.10.2,<1
Requires-Dist: waitress>=2.1.2,<3
Requires-Dist: openepub>=0.0.6,<1
Requires-Dist: pypdf>=3.17.4
Requires-Dist: subtitle-parser>=1.3.0
Requires-Dist: coverage>=7.3.1,<8 ; extra == "dev"
Requires-Dist: invoke>=2.2.0,<3 ; extra == "dev"
Requires-Dist: pip>=23.0.1 ; extra == "dev"
Requires-Dist: pipdeptree>=2.13.0,<3 ; extra == "dev"
Requires-Dist: pylint>=2.17.5,<3 ; extra == "dev"
Requires-Dist: pytest-bdd>=7.0.0,<8 ; extra == "dev"
Requires-Dist: pytest-splinter>=3.3.2,<4 ; extra == "dev"
Requires-Dist: pre-commit>=3.5.0,<4 ; extra == "dev"
Requires-Dist: black>=23.10.1,<24 ; extra == "dev"
Project-URL: Home, https://github.com/jzohrab/lute-v3
Provides-Extra: dev

# `lute3`

Learning Using Texts v3.

Lute is for learning foreign languages through reading.  `lute3` is a rewrite of the original Lute PHP application in Python and Flask.



## Requirements

Python 3.8+ (tested with python 3.8 through 3.11)

Japanese learners will also need to install MeCab.

## Install

`lute3` installs various dependencies, so you should install it in a virtual environment.  For example, using `venv`:

Create a new folder (e.g. `lute3`) anywhere on your system.

```
# Set up the virtual environment
python3.8 -m venv myenv

# Activate it (Mac or *nix)
source myenv/bin/activate

# (on Windows: myenv\Scripts\activate)

# Install everything.  Note the package name is lute3!
pip install lute3

# Start lute
python -m lute.main

# Open your web browser to http://localhost:5000
# When done, hit Ctl-C

# Stop the virtual environment.
deactivate
```

Once everything is installed, for future runs you'll just need to go into `lute3` folder created above and:

```
source myenv/bin/activate
python -m lute.main
```
