2020-03-05 12:03:18 -05:00
|
|
|
# IzzyLib
|
2020-03-05 11:20:50 -05:00
|
|
|
|
2021-06-07 16:45:29 -04:00
|
|
|
These are just a number of functions I keep reusing over and over again in most of my projects. It's okay to use them if you also find them useful
|
2020-03-07 14:25:45 -05:00
|
|
|
|
2021-06-07 16:45:29 -04:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
### From Git
|
2021-06-07 16:57:38 -04:00
|
|
|
|
2021-09-17 14:36:39 -04:00
|
|
|
$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework"
|
2021-06-07 16:45:29 -04:00
|
|
|
|
2021-09-17 14:36:39 -04:00
|
|
|
optional dependencies
|
2021-06-07 16:45:29 -04:00
|
|
|
|
2021-09-17 14:36:39 -04:00
|
|
|
- dbus
|
|
|
|
|
- hasher
|
|
|
|
|
- http_server
|
|
|
|
|
- http_urllib_client
|
|
|
|
|
- sql
|
|
|
|
|
- template
|
|
|
|
|
- tinydb
|
2021-06-07 16:45:29 -04:00
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
### Importing
|
|
|
|
|
|
2021-06-07 16:57:38 -04:00
|
|
|
Most useful classes and functions are imported in the module root, so you don't need to do any multi-level imports. Example
|
|
|
|
|
|
|
|
|
|
This is fine:
|
|
|
|
|
|
2021-09-17 14:36:39 -04:00
|
|
|
from izzylib import Database
|
2021-06-07 16:57:38 -04:00
|
|
|
|
|
|
|
|
and points to:
|
|
|
|
|
|
2021-09-17 14:36:39 -04:00
|
|
|
from izzylib.sql.database import Database
|
2021-06-07 16:57:38 -04:00
|
|
|
|
2021-09-17 14:36:39 -04:00
|
|
|
Or even simply do `import izzylib` and use `izzylib.Database()`.
|
2021-06-07 16:45:29 -04:00
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
|
|
|
|
|
All classes and functions will have docstrings. Either look through the code or run `help()` on an object
|
|
|
|
|
|
|
|
|
|
# NOTE!
|
2021-06-07 16:57:38 -04:00
|
|
|
|
|
|
|
|
Not in a stable state yet. Expect major changes
|
