Metadata-Version: 2.2
Name: blib-py
Version: 1.5.5
Summary: Boonleng's Python Library
Author-email: Boonleng Cheong <boonleng@ou.edu>
License: MIT License
        
        Copyright (c) 2018-2023 boonleng
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/boonleng/blib-py
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib

# Boonleng's Python Library

This is a collection of some convenient functions, color schemes, etc. for convenient coding in the future.

## Install Using the Python Package-Management System

```shell
pip install blib-py
```

## Install from Source for System-Wide Usage

Download the project from either GitHub or ARRC GitLab:

```shell
git clone https://github.com/boonleng/blib-py.git
```

or

```shell
git clone https://git.arrc.ou.edu/cheo4524/blib-py.git
```

Change directory to the project folder and install using `pip`.

```shell
cd blib-py
pip install .
```

## Use It Without Instlallation

It is possible to use this library without installation. Assuming that you downloaded the project into the folder `~/Developer/blib-py/src`, you can add the path to Python's search path as follows.

```python
import os
import sys

sys.path.insert(0, os.path.expanduser('~/Developer/blib-py/src'))

import blib
```

## Theme / Colors

A theme can be activated by:

```python
blib.useTheme("light")

blib.showLineColors()
```

![light](https://raw.githubusercontent.com/boonleng/blib-py/master/blob/line-colors-light.png)

```python
blib.useTheme("dark")

blib.showLineColors()
```

![dark](https://raw.githubusercontent.com/boonleng/blib-py/master/blob/line-colors-dark.png)
