Merge pull request #612 from toonarmycaptain/development

Pull recent changes, CI/dependencies/

Author: toonarmycaptain

.appveyor.yml

@@ -4,12 +4,10 @@ image: Visual Studio 2019
 
 environment:
     matrix:
-        - PYTHON: "C:\\Python38"
-        - PYTHON: "C:\\Python39"
         - PYTHON: "C:\\Python310"
-        - PYTHON: "C:\\Python38-x64"
-        - PYTHON: "C:\\Python39-x64"
+        - PYTHON: "C:\\Python311"
         - PYTHON: "C:\\Python310-x64"
+        - PYTHON: "C:\\Python311-x64"
 
 #matrix:
 #    allow_failures:

.circleci/config.yml

@@ -10,25 +10,24 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.10", "3.11"]
         experimental: [false]  # These versions must pass.
 
-#         include:
-#              experimental: true
-#            - os: ubuntu-latest
-#              python-version: 3.11-dev
-#              experimental: true
+        include:
+            - os: ubuntu-latest
+              python-version: 3.12-dev
+              experimental: true
 
 #            - os: windows-latest
 #              python-version: 3.11-dev
 #              experimental: true
 
 
     steps:
-    - uses: actions/checkout@v2  # Checkout repo.
+    - uses: actions/checkout@v3  # Checkout repo.
 
     - name: Set up production Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       if: "!endsWith(matrix.python-version, '-dev')"
       with:
         python-version: ${{ matrix.python-version }}
@@ -58,14 +57,14 @@ jobs:
         coveralls --service=github
 
     - name: Codacy Coverage Reporter
-      uses: codacy/codacy-coverage-reporter-action@0.2.0
+      uses: codacy/codacy-coverage-reporter-action@v1
       if: matrix.os == 'ubuntu_latest'
       with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
           coverage-reports: coverage.xml
 
     - name: Codecov  # upload
-      uses: codecov/codecov-action@v1.2.1
+      uses: codecov/codecov-action@v3
       with:
         files: ./coverage.xml
         name: codecov-umbrella # Optional.

.github/workflows/CI.yml

@@ -17,6 +17,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Remove `.travis.yml` 
     - Remove dependencies that were only used for TravisCI from `requirements_dev.txt`.
 - Change exit to use `raise SystemExit` with exit code 0.
+- Change generic types to use builtins (eg list, dict rather than List, Dict), per PEP 585.
+- Remove Python 3.8 support due to implementing PEP 585.
+- Change all implicity None-optional typing top explicity declare None type or Optional. 
+- Remove Python 3.9 support, add 3.11.
+- Remove CircleCI/TravisCI testing.
+- Remove sqlalchemy stubs, functionality now bundled with sqlalchemy
+- Rm codecov in favour of github-action
+
 
 ## [0.8.1-alpha] - 2020-08-29
 ### Changed

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Instructions for bumping python versions
+
+When bumping version, need to modify version specifiers in all of these files:
+
+.github/workflows/CI.yml
+.circleci/config.yml
+appveyor.yml
+
+README.md - bump supported versions. 

Python_bump.md

@@ -2,8 +2,6 @@
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
-[![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) 
 [![codecov](https://codecov.io/gh/toonarmycaptain/dionysus/branch/master/graph/badge.svg)](https://codecov.io/gh/toonarmycaptain/dionysus)
@@ -18,7 +16,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, automated install/packaging, and a full GUI/webapp are future goals.
-Supports latest two python minor versions - currently 3.8 and 3.9.
+Supports latest two python minor versions - currently 3.10 and 3.11.
 
 Excitedly welcoming contributors! 
 

README.md

@@ -6,7 +6,7 @@
 
 from pathlib import Path
 from tkinter import filedialog
-from typing import Optional, Union, List, Tuple, Callable
+from typing import Optional, Union, Callable
 
 
 def clear_screen(num_lines: int = 50) -> None:
@@ -78,7 +78,7 @@ def scrub_candidate_filename(dirty_string: str) -> str:
                     ]).rstrip()
 
 
-def ask_user_bool(question: str, invalid_input_response: str = None) -> bool:
+def ask_user_bool(question: str, invalid_input_response: str|None = None) -> bool:
     """
     Get user input, return a bool response.
     Optional additional instruction on invalid input.
@@ -98,10 +98,10 @@ def ask_user_bool(question: str, invalid_input_response: str = None) -> bool:
     return valid_responses[response.upper()]
 
 
-def save_as_dialogue(title_str: str = None,
-                     default_file_extension: str = None,
-                     filetypes: List[Tuple[str, str]] = None,
-                     suggested_filename: str = None,
+def save_as_dialogue(title_str: str|None = None,
+                     default_file_extension: str |None= None,
+                     filetypes: list[tuple[str, str]]|None = None,
+                     suggested_filename: str|None = None,
                      start_dir: Union[Path, str] = '..'
                      ) -> Optional[Path]:
     """
@@ -146,7 +146,7 @@ def save_as_dialogue(title_str: str = None,
     :param title_str: str
     :param default_file_extension: list
     :param suggested_filename: str
-    :param filetypes: List[Tuple[str, str]]
+    :param filetypes: list[tuple[str, str]]
     :param start_dir: Path or str
     :return: Path
     """
@@ -173,8 +173,8 @@ def save_as_dialogue(title_str: str = None,
     return Path(filepath_str)
 
 
-def select_file_dialogue(title_str: str = None,
-                         filetypes: List[Tuple[str, str]] = None,
+def select_file_dialogue(title_str: str|None = None,
+                         filetypes: list[tuple[str, str]]|None = None,
                          start_dir: Union[Path, str] = '..',
                          ) -> Optional[Path]:
     """
@@ -199,7 +199,7 @@ def select_file_dialogue(title_str: str = None,
     title will be "Open".
 
     :param title_str: str
-    :param filetypes: List[Tuple[str, str]]
+    :param filetypes: list[tuple[str, str]]
     :param start_dir: str
     :return: Path or None
     """
@@ -218,7 +218,7 @@ def select_file_dialogue(title_str: str = None,
     return Path(filepath_str)
 
 
-def select_folder_dialogue(title_str: str = None, start_dir: Union[Path, str] = '..') -> Optional[Path]:
+def select_folder_dialogue(title_str: str|None = None, start_dir: Union[Path, str] = '..') -> Optional[Path]:
     """
     Prompt user to select a directory.
 
@@ -250,7 +250,7 @@ def select_folder_dialogue(title_str: str = None, start_dir: Union[Path, str] =
 
 def get_user_input(prompt: str,
                    validation: Callable,
-                   validation_error_msg: Union[str, Callable] = None):
+                   validation_error_msg: Union[str, Callable]|None = None):
     """
     Generic function for getting user input.
 

dionysus_app/UI_menus/UI_functions.py

@@ -71,7 +71,7 @@ def user_cancels() -> None:
 
 
 class ImageDisplay(tk.Frame):
-    def __init__(self, image_path: Path = None, master=None) -> None:
+    def __init__(self, image_path: Path|None = None, master=None) -> None:
         super().__init__(master)
         self.master = master
         self.save_as_button_clicked = False

dionysus_app/UI_menus/chart_generator/create_chart_UI.py

@@ -1,7 +1,7 @@
 """
 Script for taking and saving data for chart.
 """
-from typing import Dict, List, Optional
+from typing import Optional
 
 from dionysus_app.class_ import Class
 from dionysus_app.student import Student
@@ -32,7 +32,7 @@ def take_score_data(current_class: Class) -> dict:
     return student_scores
 
 
-def take_student_scores(current_class: Class) -> Dict[float, List[Student]]:
+def take_student_scores(current_class: Class) -> dict[float, list[Student]]:
     """
     UI function presenting student names from supplied class one at a
     time and taking a score for each.
@@ -48,7 +48,7 @@ def take_student_scores(current_class: Class) -> Dict[float, List[Student]]:
                                  }
 
     :param current_class: Class object
-    :return: Dict[float, List[Student]]
+    :return: dict[float, list[Student]]
     """
     student_scores: dict = dict()
     for student in current_class.students:

dionysus_app/UI_menus/chart_generator/take_chart_data_UI.py

@@ -1,6 +1,6 @@
 """UI elements for class_functions"""
 from pathlib import Path
-from typing import Dict, Optional, Union
+from typing import Optional, Union
 
 import definitions
 
@@ -94,19 +94,19 @@ def create_chart_with_new_class_dialogue() -> bool:
                          invalid_input_response="Invalid response, please try again.")
 
 
-def display_class_selection_menu(class_options: Dict[int, ClassIdentifier]) -> None:
+def display_class_selection_menu(class_options: dict[int, ClassIdentifier]) -> None:
     """
     Print "Select class from list:" followed by numbered option list.
 
-    :param class_options: Dict[int, ClassIdentifier]
+    :param class_options: dict[int, ClassIdentifier]
     :return: None
     """
     print("Select class from list:")
     for key, class_ in class_options.items():
         print(f'{key}. {class_.name}')
 
 
-def take_class_selection(class_options: Dict[int, ClassIdentifier]) -> ClassIdentifier:
+def take_class_selection(class_options: dict[int, ClassIdentifier]) -> ClassIdentifier:
     """
     Prompt user to select a class, return selected class name.
 
@@ -118,7 +118,7 @@ def take_class_selection(class_options: Dict[int, ClassIdentifier]) -> ClassIden
     but this behaviour is predicated on exact match and thus not
     communicated to user.
 
-    :param class_options: Dict[int: ClassIdentifier]
+    :param class_options: dict[int: ClassIdentifier]
     :return: ClassIdentifier
     """
     while True:

dionysus_app/UI_menus/class_functions_UI.py

@@ -1,7 +1,7 @@
 """
 Application main menu.
 """
-from typing import Dict, Callable, Optional
+from typing import Callable, Optional
 
 from dionysus_app.chart_generator.create_chart import new_chart
 from dionysus_app.class_functions import create_classlist
@@ -51,7 +51,7 @@ def take_main_menu_input() -> Optional[bool]:
 
     :return: None or True
     """
-    possible_options: Dict[str, Callable] = {
+    possible_options: dict[str, Callable] = {
         '1': create_classlist,
         '2': edit_class_data,
         '3': new_chart,

dionysus_app/UI_menus/main_menu.py

@@ -8,7 +8,7 @@
 sort of overlap without obscuring the avatars, or two columns of avatars in a point column.
 """
 from pathlib import Path
-from typing import Optional, Tuple
+from typing import Optional
 
 import definitions
 
@@ -27,7 +27,7 @@
 from dionysus_app.UI_menus.UI_functions import clean_for_filename
 
 
-def new_chart(loaded_class: Class = None) -> None:
+def new_chart(loaded_class: Class|None = None) -> None:
     """
     Create a new chart with supplied class, user input.
 
@@ -75,7 +75,7 @@ def new_chart(loaded_class: Class = None) -> None:
         user_save_chart_image(chart_data_dict, chart_image_location)
 
 
-def assemble_chart_data(loaded_class: Class) -> Tuple[str, str, dict, dict]:
+def assemble_chart_data(loaded_class: Class) -> tuple[str, str, dict, dict]:
     """
     Collect data/user input for new chart.
 

dionysus_app/chart_generator/create_chart.py

@@ -5,7 +5,6 @@
     fig.subtitle('title_string')
 """
 from pathlib import Path
-from typing import List, Tuple
 
 import matplotlib.pyplot as plt
 
@@ -49,7 +48,7 @@ def set_axis(x_min: int = 0, x_max: int = 100, x_step: int = 10):
     plt.yticks([])
 
 
-def add_avatar_to_plot(ax, avatar_path, xy_coords: List[Tuple[int, int]]) -> None:
+def add_avatar_to_plot(ax, avatar_path, xy_coords: list[tuple[int, int]]) -> None:
     """
     Take avatar, add avatar to ax at given coords.
 
@@ -63,7 +62,7 @@ def add_avatar_to_plot(ax, avatar_path, xy_coords: List[Tuple[int, int]]) -> Non
 
     :param ax:
     :param avatar_path: Path object
-    :param xy_coords: List[Tuple[int, int]]
+    :param xy_coords: list[tuple[int, int]]
     :return: None
     """
     valid_avatar_path = validate_avatar(avatar_path)