Simple, easy-to-use loading sequence/progress bar module.
Project description
# PyLoadBar
> _**Simple, easy-to-use loading sequence module.**_
## About
---
- Useful for small intermittant pauses between console text returns, or code actions.
- Customizable, optional loading and completion messages available to print to the console.
- Loading message defaults to `"Loading..."`.
- Completion message defaults to `"Done!"`.
- Includes an _optional_ progress bar (simple change the `progressbar` parameter to equal `"True"`).
## Installing PyLoadBar
---
### Using pip
> _Easiest_ method. Highly recommended over manual installation.
- Run the following to install:
```python
pip install PyLoadBar
```
- You should now be able to import `PyLoadBar` directly to your application.
---
### Manual Installation
> _Not_ recommended.
1. Download source code from the [PyLoadBar GitHub](https://github.com/PyLoadBar) repo.
2. Extract contents of the containing `**.zip` file to desired install location.
3. Navigate to directory containing extracted contents, and open said folder within a terminal.
4. Enter `pip install -r requirements.txt` to install all dependencies for this package.
5. Finally, move the `"PyLoadBar-vx.x.x"` diretory to your global Python 3rd-party package installation directory to be able to import `PyLoadBar` like any other module:
- `"path/to/python/Lib/site-packages/here"`
6. Done!
---
## Usage
- Within a `.py` project, simply import the `PyLoadBar` module to start using your custom loading sequence.
- `PyLoadBar` is _very_ simple to use.
- For example, try running the following:
```python
from PyLoadBar import load
def add50(x):
load(f'Adding 50 to {x}', 'Okay!\n')
return x + 50
print(add50(50))
```
- This will return:
```python
Solving...
100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:00<00:00, 8.94it/s].
Okay!
100
```
- Of course, the _loading_ and _loading complete_ messages can be customized by passing custom strings to the `msg_loading` and `msg_complete` parameters respectively.
- Note that the progress bar **can** be toggled using the `progressbar: bool` parameter within the `load(msg_complete: str, msg_loading: str, progressbar: bool, time: int)` method.
- The time taken to completely fill the progress bar can be determined using the `time: int` parameter.
- Every 10 units = 1 second.
- e.g. `load(time=5)` (default) would take 0.5 seconds to fill the progress bar.
---
## Contributing to PyLoadBar
- If you wish to help contribute to this project, along with the tools you need to develop and run tests, please run the following in your virtual env:
'''python
pip install -e .[dev]
'''
## Contact
- If you have any questions, comments, or concerns that cannot be alleviated through the [project's GitHub repository](https://github.com/schlopp96/PyLoadBar), please feel free to contact me through my email address:
- `schloppdaddy@gmail.com`
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
PyLoadBar-0.0.4.tar.gz
(17.1 kB
view hashes)
Built Distribution
PyLoadBar-0.0.4-py3-none-any.whl
(16.8 kB
view hashes)
Close
Hashes for PyLoadBar-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 066c5272d7cb0ccb5af7381e22c9a720b979b21ebd2d32da50a5e034036ff880 |
|
MD5 | c31ad706ce32080aa746dedda726c733 |
|
BLAKE2b-256 | 8e99568a5d1f48ec9a9148d6d0f18f386275eef044de36d378f4f7ffeb00e5ee |