Merge pull request #352 from toonarmycaptain/development

Optimise SQLiteDatabase

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.1-alpha] - 2020-08-29
+### Changed
+- Better optimised `SQLiteDatabase` queries. 
+### Removed
+- `data_version_conversion.py` is removed. NB Still available on GitHub.  
+  - No intention to maintain interoperability of very old data formats going forward.
+  - Similar functionality may return in future releases, for conversion between backends. 
+
 ## [0.8.0-alpha] - 2020-08-20
 ### Added
 - `SQLiteDatabase` - using python's builtin `sqlite3` module.
@@ -17,7 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Retrieval of avatar paths moved from `take_chart_data_UI.take_student_scores` to `process_chart_data.generate_avatar_coords`, which now takes an additional `class_id`.
 parameter to facilitate getting avatar paths from `JSONDatabase`.
 - Charts saved as JSON now store the student name, rather than path to an avatar image. Student represented by the default avatar are no longer anonymous!
-- Charts are now saved at 1080p proportion (19.20, 10.80, explicitly saved in png format at better quality 300dpi.
+- Charts are now saved at 1080p proportion (19.20, 10.80), explicitly saved in png format at better quality 300dpi.
 ### Removed
 - Remove `setup.py` - package is not designed to be installed!
 ### Depreciated

README.md

@@ -17,7 +17,7 @@
 
 **dionysus** is an open source CLI app primarily aimed at teachers that charts student results for display using avatars, nicknames, or student names. 
 
-Currently in alpha release, fuller features, proper install/packaging, database backend, and a full GUI/webapp are future goals.
+Currently in alpha release, fuller features, automated install/packaging, and a full GUI/webapp are future goals.
 Supports latest two python minor versions - currently 3.7 and 3.8.
 
 Excitedly welcoming contributors! 
@@ -29,12 +29,12 @@ Leave a comment or [raise an issue](https://github.com/toonarmycaptain/dionysus/
 ### Installation
 
 Currently to use the application, you must clone or download the project from here on github. See [releases](https://github.com/toonarmycaptain/dionysus/releases) for a `zip` or `tar.gz`.
-You will need Python 3.6+, unzip the project if necessary, navigate to the project directory and run `pip install -r requirements.txt` or manually install the dependencies `pip install ...` you find in the requirements file.
+You will need Python 3.7+, unzip the project if necessary, navigate to the project directory and run `pip install -r requirements.txt` or manually install the dependencies `pip install ...` you find in the requirements file.
 For development you will also need `pip install -r requirements_dev.txt`.
 
 ### Running the application
 
-Either click on `app_main.py` in the project folder, or navigate to the folder and run `python -m app_main` on the command line.
+Click on `app_main.py` in the project folder, or navigate to the folder and run `python -m app_main`/`python3 app_main.py` in terminal (depending on OS).
 
 #### Versioning
 As much as possible this project will follow [Semantic Versioning](https://semver.org/).