Update 'README.md'
This commit is contained in:
parent
27ec8c96a8
commit
a65a1e8733
35
README.md
35
README.md
|
@ -7,26 +7,43 @@ These are just a number of functions I keep reusing over and over again in most
|
|||
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
|
||||
|
||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-base&subdirectory=base"`
|
||||
|
||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-http-server&subdirectory=http_server"`
|
||||
|
||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-http-requests-client&subdirectory=requests_client"`
|
||||
|
||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-sql&subdirectory=sql"`
|
||||
|
||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-templates&subdirectory=template"`
|
||||
|
||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-tinydb&subdirectory=tinydb"`
|
||||
|
||||
### From Source
|
||||
|
||||
$(venv)/bin/python -m pip install ./base ./http_server ./requests_client ./sql ./template ./tinydb
|
||||
`$(venv)/bin/python setup.py install ['all' or a combination of these: 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()`.
|
||||
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:
|
||||
|
||||
`from izzylib import SqlDatabase`
|
||||
|
||||
and points to:
|
||||
|
||||
`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
|
||||
|
||||
Not in a stable state yet. Expect major changes
|
||||
|
|
Loading…
Reference in a new issue