pyglossary

(โ˜… 2,668)

A tool for converting dictionary files aka glossaries. Mainly to help use our offline glossaries in any Open Source dictionary we like on any operating system / device.

  • .gitignore
  • .sh-list
  • __init__.py
  • _license-dialog
  • about
  • ARCHITECTURE.md
  • AUTHORS
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • config.json
  • CONTRIBUTING.md
  • Dockerfile
  • help
  • LICENSE
  • main.py
  • pyproject.toml
  • README.md
  • requirements-test.txt
  • requirements.txt
  • run-with-docker.sh
  • setup.py

# Installation Guide

1. Get the code
git clone https://github.com/ilius/pyglossary

Downloads the entire project code from GitHub to your computer.

cd pyglossary

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t pyglossary .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 pyglossary

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
- Requires: `pip install prompt_toolkit`

Installs the Python libraries listed in requirements.txt (or similar).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd scripts/ci/mac-slint

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation