Added documentation & fixed imports

Author: mplattu

README.md

@@ -1,2 +1,15 @@
-# nordpool-db
-Library for storing retrieving and storing Nord Pool spot data in order to tell cheapest hours
+# nordpool_db
+
+Library for storing retrieving and storing Nord Pool spot data in order to tell cheapest hours.
+
+## Installing
+
+`pip3 install git+https://github.com/mplattu/nordpool_db.git`
+
+## Upgrading
+
+`pip3 install -U git+https://github.com/mplattu/nordpool_db.git`
+
+## Examples
+
+See `examples/`

examples/cheapest_hours.py

@@ -5,7 +5,7 @@
 import pytz
 
 from nordpool import elspot
-from nordpool_db import NordpoolDb
+from nordpool_db import nordpool_db
 
 SQLITE_DB = "/tmp/npdb_example.db"
 
@@ -17,7 +17,7 @@
 if os.path.isfile(SQLITE_DB):
     print(f'Warning: Using your existing database at {SQLITE_DB}')
 
-nordpool_db = NordpoolDb(SQLITE_DB)
+nordpool_db = nordpool_db.NordpoolDb(SQLITE_DB)
 tz = pytz.timezone(TZ)
 dt_yesterday = tz.localize(datetime.today()-timedelta(days=1))
 

examples/dump_prices.py

@@ -4,7 +4,7 @@
 from datetime import datetime, timedelta
 
 from nordpool import elspot
-from nordpool_db import NordpoolDb
+from nordpool_db import nordpool_db
 
 SQLITE_DB = "/tmp/npdb_example.db"
 AREAS = ['FI', 'EE']
@@ -14,7 +14,7 @@
 if os.path.isfile(SQLITE_DB):
     print(f'Warning: Using your existing database at {SQLITE_DB}')
 
-nordpool_db = NordpoolDb(SQLITE_DB)
+nordpool_db = nordpool_db.NordpoolDb(SQLITE_DB)
 
 dt_today = datetime.today()
 dt_yesterday = datetime.today()-timedelta(days=1)