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
You only need to install the base and whatever sub-modules you want to use
### From Git
$(venv)/bin/python -m pip install -e git+https://git.barkshark.xyz/izaliamae/izzylib.git#egg=izzylib-base& subdirectory=base
$(venv)/bin/python -m pip install -e git+https://git.barkshark.xyz/izaliamae/izzylib.git#egg=izzylib-http-server& subdirectory=http_server
$(venv)/bin/python -m pip install -e git+https://git.barkshark.xyz/izaliamae/izzylib.git#egg=izzylib-http-requests-client& subdirectory=requests_client
$(venv)/bin/python -m pip install -e git+https://git.barkshark.xyz/izaliamae/izzylib.git#egg=izzylib-sql& subdirectory=sql
$(venv)/bin/python -m pip install -e git+https://git.barkshark.xyz/izaliamae/izzylib.git#egg=izzylib-templates& subdirectory=template
$(venv)/bin/python -m pip install -e git+https://git.barkshark.xyz/izaliamae/izzylib.git#egg=izzylib-tinydb& subdirectory=tinydb
### From Source
$(venv)/bin/python -m pip install ./base ./http_server ./requests_client ./sql ./template ./tinydb
## Documentation
### Importing
Most useful classes and functions are imported in the module root, so you don't need to do any multi-level imports. For example, just do `from izzylib import SqlDatabase` instead of `from izzylib.sql.generic import SqlDatabase` . Or even simply do `import izzylib` and use `izzylib.SqlDatabase()` .
### Usage
All classes and functions will have docstrings. Either look through the code or run `help()` on an object
# NOTE!
not in a stable state yet. Expect major changes
