This repository is for two things:
-
Demostrate a good practice Python work pipeline (with unit testing, isolated virtual environment, src and tests separation).
-
An actual project of transliteration of Russian and Ukrainian languages to latin script. It provides a CLI. I plan to add an HTTP microservice.
Clone this repository and go to the repository directory:
git clone git@github.com:axxeny/latinoslav.git
cd latinoslavPrepare 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 . |
Make sure to prepare the environment as in Getting started. And then:
python -m latinoslavMake sure to prepare the environment as in Getting started. And then:
pytestMake sure to prepare the environment as in Getting started. And then:
flake8 src tests setup.pyMake sure to prepare the environment as in Getting started. And then:
black .