Metadata-Version: 2.1
Name: happy-little-helpers
Version: 0.0.3
Summary: a collection of happy little helpers.
Author-email: wyattlovesgrapes <wyattlovesgrapes@gmail.com>
Project-URL: Homepage, https://github.com/wyattlovesgrapes/happy-little-helpers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# happy-little-helpers

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)  

**v0.0.3**  

#

happy_little_helpers is a python package that gives you some happy little utils including:


## flash_env

easy flash drive credential management for moving from system to system.

```
get_flash_path(root_directory) - get the path to your credentials flash drive automatically 

read_env(flash_path) - check things are working using test credentials
```
## debugger

quickly turn debugging console prints on and off

```
debug_print() - replaces the print() function

enable_debug_mode() - global function to enable debugging

disable_debug_mode() - global function to disable debugging (this is the default behavior)

```


## project-structure
```
happy-little-helpers
├─ .gitignore
├─ README.md
├─ LICENSE
├─ pyproject.toml
├─ src/  
|   └─ happy_little_helpers/
│     ├─ __init__.py
│     ├─ debugger.py
│     └─ flash_env.py
└─ tests/
   ├─ __init__.py
   ├─ credentials/
   │  └─ happy-little-helpers/
   │     └─ .env
   ├─ main_test.py
   └─ pythonpath.txt

```

## how to test locally

1. navigate to the root package directory `happy-little-helpers` and add the temp `PYTHONPATH` found in `happy-little-helpers/tests/pythonpath.txt`: 

```

Linux (Tested in Ubuntu):
export PYTHONPATH=/home/<username>/Documents/github/happy-little-helpers/src:$PYTHONPATH

Windows 10:
export PYTHONPATH=C:\Users\<username>\Documents\github\happy-little-helpers\src:$PYTHONPATH
```

2. format a flash drive and name the partition `credentials`. 

3. copy the contents of the `credentials` directory to your newly formated drive.

4. run `python3 tests/main_test.py` from your root directory to print the demo .env retrieved from your credentials flash drive.

## how to build and distribute

```
python3 -m build

python3 -m twine upload dist/*
```
