Skip to content

axxeny/latinoslav

Repository files navigation

Python package Code style: black

What is this repository?

This repository is for two things:

  1. Demostrate a good practice Python work pipeline (with unit testing, isolated virtual environment, src and tests separation).

  2. An actual project of transliteration of Russian and Ukrainian languages to latin script. It provides a CLI. I plan to add an HTTP microservice.

Getting started

Clone this repository and go to the repository directory:

git clone git@github.com:axxeny/latinoslav.git
cd latinoslav

Prepare your terminal or shell by activating the virtual environment and installing the necessary packages. In this directory:

Operating System Execute terminal or shell commands
Linux or macOS
python3 -m venv venv
source venv/bin/activate
pip install --require-virtualenv --requirement requirements.txt
pip install --require-virtualenv --editable .
Windows PowerShell
python3 -m venv venv
venv\Scripts\Activate.ps1
pip install --require-virtualenv --requirement requirements.txt
pip install --require-virtualenv --editable .
Windows cmd.exe
python3 -m venv venv
venv\Scripts\activate.bat
pip install --require-virtualenv --requirement requirements.txt
pip install --require-virtualenv --editable .

Usage

Run CLI

Make sure to prepare the environment as in Getting started. And then:

python -m latinoslav

Development

Run tests

Make sure to prepare the environment as in Getting started. And then:

pytest

Lint code with Flake8

Make sure to prepare the environment as in Getting started. And then:

flake8 src tests setup.py

Reformat code with Black

Make sure to prepare the environment as in Getting started. And then:

black .

About

Transliterate Russian or Ukrainian language to latin script. CLI. In the future: http microservice

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages