Go to file
2020-08-18 10:23:56 -04:00
docs Consistently use bytes everywhere for stream data 2019-08-13 15:53:05 -04:00
extras Fix #! at top of shell scripts for py3 and venvs 2020-08-05 17:02:30 -04:00
nilmdb flake8: fix style 2020-08-18 10:22:50 -04:00
tests tests: fix test databases 2020-08-18 10:23:56 -04:00
.coveragerc Remove old files from .coveragerc exclusions 2019-08-14 19:42:00 -04:00
.gitattributes Incorporate versioneer for versioning 2013-02-05 18:49:07 -05:00
.gitignore Clean up README 2019-08-30 16:29:39 -04:00
Makefile Add pylint config and selectively fix some pylint errors 2019-08-30 16:29:39 -04:00
MANIFEST.in Update setup.py and build instructions 2019-08-29 14:52:55 -04:00
README.md Bump Python version requirement 2020-08-07 15:56:53 -04:00
requirements.txt Add yappi dependency for "nilmdb-server -y", but don't require ipython 2020-08-06 22:55:27 -04:00
setup.cfg Fix flake8-reported issues with fsck 2020-08-06 23:10:51 -04:00
setup.py Fix #! at top of shell scripts for py3 and venvs 2020-08-05 17:02:30 -04:00
versioneer.py Update build system for Python 3 2019-07-25 10:34:20 -04:00

nilmdb: Non-Intrusive Load Monitor Database

by Jim Paris jim@jtan.com

NilmDB requires Python 3.8 or newer.

Prerequisites:

# Runtime and build environments
sudo apt install python3 python3-dev python3-venv python3-pip

# Create a new Python virtual environment to isolate deps.
python3 -m venv ../venv
source ../venv/bin/activate   # run "deactivate" to leave

# Install all Python dependencies
pip3 install -r requirements.txt

Test:

python3 setup.py nosetests

Install:

Install it into the virtual environment

python3 setup.py install

If you want to instead install it system-wide, you will also need to install the requirements system-wide:

sudo pip3 install -r requirements.txt
sudo python3 setup.py install

Usage:

nilmdb-server --help
nilmdb-fsck --help
nilmtool --help

See docs/wsgi.md for info on setting up a WSGI application in Apache.