hamid-dionysus / tekrar

create loading animation in python cli project ...

---

---

what is tekrar

create loading animation in python cli project ...

• Generally you can use tekrar in two methods ...

  • sleep
    

    maybe a unique example similar to time.sleep ...
    pause the python cli project and display the loading animation for a few seconds ...
    

  • function
    

    show loading animation will be displayed until the function process is completed ...
    

---

installation

• install by pip

  # linux
  
  sudo python3 -m pip install tekrar
  
  # windows
  
  py -m pip install tekrar
  

• install by setup.py

  # linux
  
  sudo python3 -m pip install https://github.com/sys113/tekrar/archive/0.1.1.zip
  
  # windows
  
  py -m pip install https://github.com/sys113/tekrar/archive/0.1.1.zip
  

---

example

• function

  • 1 : curl download file
         arguments used : function, argument, speed, output
  • 2 : write numbers 1 to 333333 in a file
         arguments used : function, speed, method, output and save function return value

• sleep

• 1 : show loading animation for a few seconds
       arguments used : sleep , speed , method

---

description

• speed

    # set loading speed ...
    
    # range 1 to 10 ...
    # default value is 3 ...
    
    speed = 5

• method

    # set loading animation method ...
    
    # only 1 or 2 ...
    # default value is 1 ...
    
    method = 2

  • method 1

  

  • method 2

  

• sleep

    # pause the python cli project and display the loading animation for 8 seconds ...
    # maybe a unique example similar to time.sleep ...
    
    # argument 'sleep' must be a int type ...
    # cannot use simultaneously 'sleep' and 'function' argument ...
    
    sleep = 8

• function

    # show loading if 'x' function running ...
    
    # cannot use simultaneously 'sleep' and 'function' argument ...
    
    function = x

• argument

  # use this method if 'function' has 'argument' ...
  
  # argument 'argument' must be a int type ...
  
  argument = ['tekrar','SYS113']

• output

  # if 'function' has arguments then use this way for hide function output ...
  
  # default value is True
  # argument 'output' must be boolean type ...
  
  output = True

• save function return value

  # call tekrar.loading function in a variable ...
  
  save_return_value = tekrar.loading(function = func, argument = ['hi'], output = True, speed = 5, method = 2)

---

copyright

copyright SYS113 - 2019.

---

license

MIT license , please see LICENSE file.

---

donate

• for iranian users   :       id pay      -                    https://idpay.ir/sys113
• for global users   :  BTC wallet id  -   149JgUmFqG6MvFg79Ldrvdk2bN35ByhMuw

---

contact me

• email
• telegram
• instagram

---

last word

hope this is tekrar useful to you and enjoy it.

---

tekrar logo ❤️ mohamad moradiyani

---

tekrar's Issues

Cursor remains hidden if supplied function returns immediately

test case:

loading(function=lambda: sleep(0))

(the cursor remains hidden after call returns)