This file is 2-lang

• EN Version
• RU Версия

EN

For Start

• Automatic

  • exec pip install ttykit

• Manually

  • Dev version

    • clone repository

      git clone https://github.com/He-STALIN/ttykit.git
      

    • change to dir and exec

      pip install .
      

  • From Release

    • download any release from Releases

    • exec in terminal

      pip install <path>
      

      where <path> you need write path to the downloaded release file

support the project

• If you would like the project to continue developing, you can make a donation.
• Account: 4100 1186 1873 2284 (YouMoney)
• or
• Find bugs in the library and report them in the issues section on GitHub.

Code Examples

• Status

  from ttykit import Status, TaskState
  
  with Status("Something unit", spinner="line") as status:
      ... # your payload
      status.set_state(TaskState.SUCCESS)
  

• Progress

  from ttykit import Progress
  
  with Progress(100, "Some desc", 40) as progress:
      ... # your code
      progress.update(value)
      ... # your code again
      progress.finish()
  

• for more code examples see CODE USE

License

• This lib uploading with MIT License. See License

Versions

• You interesting see versions? You can see CHANGELOG

RU

Для начала использования

• Авто-установка

  • выполните pip install ttykit в терминале

• Вручную

  • Разрабатываемую версию

    • скопируйте репозиторий

      git clone https://github.com/He-STALIN/ttykit.git
      

    • перейдите в папку и выполни

      pip install .
      

  • Релизную версию

    • Скачайте любой релиз из вкладки "Releases"

    • выполните в терминале

      pip install <path>
      

      Где <path> вам нужно вставить путь к скачанному файлу релиза

Поддержите проект

• Если вы желаете, чтобы проект разрабатывался дальше, вы можете сделать пожертвование.
• Счет: 4100 1186 1873 2284 (ЮМани)
• или
• Ищите ошибки в библиотеке и сообщайте о них в issues на GitHub.

Примеры кода

• Status класс

  from ttykit import Status, TaskState
  
  with Status("Какая-то задача", spinner="line") as status:
      ... # ваша нагрузка
      status.set_state(TaskState.SUCCESS)
  

• Progress класс

  from ttykit import Progress
  
  with Progress(100, "Некоторое описание", 40) as progress:
      ... # ваш код
      progress.update(value)
      ... # и снова ваш код
      progress.finish()
  

• Для большего количества примеров и описания смотрите CODE USE

Лицензия

• Это библиотека распространяется под лицензией MIT. Смотреть лицензию

Версии

• вам интересно узнать про версии? Вы можете посмотреть CHANGELOG