v0.2.0-alpha release

.circleci/config.yml

@@ -0,0 +1,33 @@
+# Python CircleCI 2.0 configuration file
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/python:3.7
+
+    working_directory: ~/dionysus
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            python3 -m venv venv
+            . venv/bin/activate
+
+            pip install -r requirements_dev.txt
+            pip install -r requirements.txt
+
+            mkdir test-results
+
+      - run:
+          name: run tests
+          command: |
+            . venv/bin/activate
+
+            pytest -v --cov=/home/circleci/dionysus/ --junitxml=../test-results/junit.xml
+            coverage xml
+
+      - store_test_results:
+          path: test-results

.codebeatignore

@@ -0,0 +1 @@
+**/test_suite/**

.coveragerc

@@ -5,4 +5,5 @@ include = /home/travis/build/toonarmycaptain/dionysus/*
 omit =
      *.yml
      *.md
-
+     test_suite/*
+     venv/*

.gitignore

@@ -1,7 +1,7 @@
 .idea/
 dionysus_env/
 dionysus_app/app_data/
-
+docs/  # don't test docs build
 
 
 

.travis.yml

@@ -1,8 +1,10 @@
 language: python
+sudo: false
+dist: xenial
 
 os:
-  - windows
-  - linux
+    - windows
+    - linux
 
 
 cache: pip
@@ -13,20 +15,21 @@ python:
 
 
 matrix:
+    include:  # Workaround for python 3.7.
+        - python: "3.7"
+          dist: xenial
+          sudo: required
+
     fast_finish: true
     allow_failures:
         - os: windows  # allow failure on Win until Travis-Win supports python.
-        - python: "3.7"  # Travis CI not supporting 3.7 yet
+#        - python: "3.7"  # Travis CI not supporting 3.7 yet
 
 
 install:
     - pip install -r requirements_dev.txt
     - pip install -r requirements.txt
 
-    - pip install pytest-cov
-    - pip install coveralls
-    - pip install coverage
-    - pip install codacy-coverage
 
 # command to run tests
 script:

CHANGELOG.md

@@ -4,8 +4,56 @@ 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).
 
-## [Unreleased]
+## [0.2.0-alpha] - 2018-12-31
+### Added
+- Save chart dialogue.
+    - OS native 'save as' dialogue.
+    - Starting default folder to class folder in dionysus charts ie dionysus_charts/class_name.
+    - Default filename provided is sanitised user supplied chart name.
+    - User can save chart in user selected location with user supplied filename.
+    - Copy of image also saved in app_data/class_data/class_name/chart_data along with the chart data. 
+- User defined location for dionysus_charts folder.  
+    - Prompt to set location on startup, default location in application parent directory if user declines to set location.
+    - Charts for each class will by default save in sub-folders for each class in dionysus_charts folder.
+    - OS native prompt for location selection. 
+- Add user settings, settings menu.
+    - User can configure, reconfigure dionysus_charts save folder location.  
+      Changing location moves current folder and contents.
+- Add "not implemented" message when "Edit a classlist" is selected from main menu.    
+- CI/Testing
+    - Travis CI
+        - Use Xenial distribution for Python 3.7 to build on Travis.
+    - circleci
+        - Add Python 3.7 testing via [circleci](https://codeclimate.com/github/toonarmycaptain/dionysus). 
+        - circleci badge added to README.
+    - Code Climate
+        - Connect dionysus to [Code Climate](https://codeclimate.com/github/toonarmycaptain/dionysus)
+        - Add Code Climate Maintainability badge to README.
+    - Codebeat
+        - Add [Codebeat](https://codebeat.co/projects/github-com-toonarmycaptain-dionysus-master) code quality checker.
+        - Add .codebeatignore to ignore test code from code quality metrics    
+    - Codeship
+        - Add [Codeship CI](https://app.codeship.com/projects/320107), badge to README.
+### Changed
+- Charts save to correct location in dionysus_charts rather than in app_home folder.
+- Reorganise menus/UI scripts into folder UI_menus.
+- Moved app initialisation code to initialise_app.py.
+       - data_folder_check moved here.
+- REGISTRY variable moved to definitions.py.
+- CI/Testing
+    - Move testing/development dependencies to requirements_dev.txt.
+    - Coveralls
+        - Correct coverage calculation to only include project code (not testing or python env code).
+    - Travis CI
+        - Install testing dependencies from requirements_dev.txt rather than manually. 
+        - Require passing tests Python 3.7 on Linux for successful build.
+ ### Removed
+- app_data/image_data folder. 
+    - Unnecessary as saving images to external folder, and to class_data/*/chart_data folder. 
+- class_registry.py.
+    - REGISTRY variable moved to definitions.py.
 
+
 ## [0.1.1-alpha] - 2018-12-12
 ### Added
 - OS native file select dialogue 
@@ -39,14 +87,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Remove in next release.
 
 ## [0.1.0-alpha] - 2018-12-10
-Initial alpha release! Dionysus will take classlists, and successfully produce charts with the default avatar.
+Initial alpha release! Dionysus will take class lists, and successfully produce charts with the default avatar.
 
 ### Known bugs/non-functional features:
 - setup.py is boilerplate and untested.
 - User supplied avatar does not copy to app data folder and thus does not work in app.
 - No indication of chart save location and not saving in desired/intended location in app_data/image_data/
 - Need to cut and paste/type user supplied avatar location is too awkward.
 - Preview/display of created chart does not reflect generated image accurately.
-
-
-

README.md

@@ -1,5 +1,16 @@
 ## dionysus - Avatar chart generator
-[![Build Status](https://travis-ci.org/toonarmycaptain/dionysus.svg?branch=master)](https://travis-ci.org/toonarmycaptain/dionysus) [![Build status](https://ci.appveyor.com/api/projects/status/yb33uwd13tkv7l79?svg=true)](https://ci.appveyor.com/project/toonarmycaptain/dionysus) [![Coverage Status](https://coveralls.io/repos/github/toonarmycaptain/dionysus/badge.svg)](https://coveralls.io/github/toonarmycaptain/dionysus) [![BCH compliance](https://bettercodehub.com/edge/badge/toonarmycaptain/dionysus?branch=master)](https://bettercodehub.com/) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d24e9508258849c2b40760fce3448c6b)](https://www.codacy.com/app/toonarmycaptain/dionysus?utm_source=github.com&utm_medium=referral&utm_content=toonarmycaptain/dionysus&utm_campaign=Badge_Grade) [![CodeFactor](https://www.codefactor.io/repository/github/toonarmycaptain/dionysus/badge/master)](https://www.codefactor.io/repository/github/toonarmycaptain/dionysus/overview/master) [![Updates](https://pyup.io/repos/github/toonarmycaptain/dionysus/shield.svg)](https://pyup.io/repos/github/toonarmycaptain/dionysus/) [![Known Vulnerabilities](https://snyk.io/test/github/toonarmycaptain/dionysus/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/toonarmycaptain/dionysus?targetFile=requirements.txt) [![Python 3](https://pyup.io/repos/github/toonarmycaptain/dionysus/python-3-shield.svg)](https://pyup.io/repos/github/toonarmycaptain/dionysus/) 
+[![Build Status](https://travis-ci.org/toonarmycaptain/dionysus.svg?branch=master)](https://travis-ci.org/toonarmycaptain/dionysus) 
+[![CircleCI](https://circleci.com/gh/toonarmycaptain/dionysus/tree/master.svg?style=svg)](https://circleci.com/gh/toonarmycaptain/dionysus/tree/master) 
+[![Build status](https://ci.appveyor.com/api/projects/status/yb33uwd13tkv7l79?svg=true)](https://ci.appveyor.com/project/toonarmycaptain/dionysus) 
+[![Coverage Status](https://coveralls.io/repos/github/toonarmycaptain/dionysus/badge.svg)](https://coveralls.io/github/toonarmycaptain/dionysus) 
+[![BCH compliance](https://bettercodehub.com/edge/badge/toonarmycaptain/dionysus?branch=master)](https://bettercodehub.com/) 
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d24e9508258849c2b40760fce3448c6b)](https://www.codacy.com/app/toonarmycaptain/dionysus?utm_source=github.com&utm_medium=referral&utm_content=toonarmycaptain/dionysus&utm_campaign=Badge_Grade) 
+[![codebeat badge](https://codebeat.co/badges/c7b02602-ed39-46ff-9513-d06217fdfab4)](https://codebeat.co/projects/github-com-toonarmycaptain-dionysus-master) 
+[![CodeFactor](https://www.codefactor.io/repository/github/toonarmycaptain/dionysus/badge/master)](https://www.codefactor.io/repository/github/toonarmycaptain/dionysus/overview/master) 
+[![Codeship Status for toonarmycaptain/dionysus](https://app.codeship.com/projects/43b55830-ee0a-0136-e887-0e72079f591a/status?branch=master)](https://app.codeship.com/projects/320107)
+[![Updates](https://pyup.io/repos/github/toonarmycaptain/dionysus/shield.svg)](https://pyup.io/repos/github/toonarmycaptain/dionysus/) 
+[![Known Vulnerabilities](https://snyk.io/test/github/toonarmycaptain/dionysus/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/toonarmycaptain/dionysus?targetFile=requirements.txt) 
+[![Python 3](https://pyup.io/repos/github/toonarmycaptain/dionysus/python-3-shield.svg)](https://pyup.io/repos/github/toonarmycaptain/dionysus/) 
 
 **dionysus** is an open source CLI app primarily aimed at teachers that charts student results for display using avatars, nicknames, or student names. 
 

app_main.py

@@ -4,28 +4,12 @@
 import os
 import sys
 
-import dionysus_app.class_registry as class_registry
+import definitions
 
 from dionysus_app.class_registry_functions import cache_class_registry, check_registry_on_exit
-from dionysus_app.data_folder import DataFolder
-from dionysus_app.main_menu import run_main_menu
-
-
-def data_folder_check():
-    """
-    Check data folders exist, create them if they do not.
-
-    :return: None
-    """
-
-    data_folders = {
-        DataFolder.APP_DATA: DataFolder.generate_rel_path(DataFolder.APP_DATA.value),
-        DataFolder.CLASS_DATA: DataFolder.generate_rel_path(DataFolder.CLASS_DATA.value),
-        DataFolder.IMAGE_DATA: DataFolder.generate_rel_path(DataFolder.IMAGE_DATA.value),
-        }
-
-    for key in data_folders:
-        data_folders[key].mkdir(parents=True, exist_ok=True)
+from dionysus_app.initialise_app import app_init
+from dionysus_app.UI_menus.main_menu import run_main_menu
+from dionysus_app.settings_functions import load_chart_save_folder
 
 
 def run_app():
@@ -38,9 +22,14 @@ def run_app():
     """
     os.chdir(sys.path[0])  # Make sure cwd is directory os script.
 
-    data_folder_check()
+    app_init()
+
+
+    # load runtime variables
+    definitions.REGISTRY = cache_class_registry()
+
+    definitions.DEFAULT_CHART_SAVE_FOLDER = load_chart_save_folder()
 
-    class_registry.REGISTRY = cache_class_registry()
 
     run_main_menu()  # startup checks successful, enter UI.
 

definitions.py

@@ -1,3 +1,7 @@
 import os
 
 ROOT_DIR = os.path.dirname(os.path.abspath(__file__)) # Global root directory
+
+REGISTRY = None
+
+DEFAULT_CHART_SAVE_FOLDER = None