Examtracker 1.2.1__tar.gz → 1.2.3__tar.gz

{examtracker-1.2.1/src/Examtracker.egg-info → examtracker-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Examtracker
-Version: 1.2.1
+Version: 1.2.3
 Summary: A Python exam tracker for the Lernphase .It allows you to keep track of all exams you have completed and the scores you achieved.
 Author-email: Samuel Huwiler <samuel.huwiler@gmx.ch>
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
-Requires-Python: >=3.13
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: textual
@@ -35,8 +35,12 @@ Requires-Dist: pydantic
 Requires-Dist: pydantic-settings
 Requires-Dist: pathlib
 Requires-Dist: pyyaml
+Requires-Dist: rich
+Requires-Dist: pymysql
+Requires-Dist: cryptography
 Dynamic: license-file
 
+![test](https://github.com/Samhuw8a/Examtracker/actions/workflows/test.yml/badge.svg) 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 ![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FSamhuw8a%2FExamtracker%2Fmaster%2Fpyproject.toml&color=d8634c)
@@ -92,6 +96,7 @@ By default, the program searches for:
 
 ```yaml
 database_path: "~/.config/examtracker/examtracker.db"
+database_uri: "sqllite:///~/.config/examtracker/examtracker.db"
 ```
 
 </details>
@@ -132,6 +137,7 @@ Environment variables override values defined in `config.yml`.
 - `id`
 - `name`
 - `semester_id`
+- `exam_grade`
 
 ### `semester`
 - `id`
@@ -141,10 +147,18 @@ Environment variables override values defined in `config.yml`.
 
 # TODO
 
+- [x] Allow for floating point values for the points scored
 - [x] Handle SQL errors  
 - [x] Initialize database  
 - [x] Configuration file support  
 - [x] Abort edit and add screens  
 - [x] Cross-platform config discovery  
-- [ ] Improve CSS  
+- [x] Improve CSS  
 - [x] enable Editing Exams and Semester
+- [x] Feature where you can add the grade you got in the exams
+- [ ] Enable externaly hosted database in config
+- [x] Add a Notes section to the Exams for adding notes
+- [  ] Fix sizing issue when removing a large note from an exam
+- [x] Save the collumn when entering a submenu to set the cursor to the same place as before instead of to the top
+- [x] write Tests
+- [x] automagicly push new pypi versions and make release upon github tag push tag push

{examtracker-1.2.1 → examtracker-1.2.3}/README.md

@@ -1,3 +1,4 @@
+![test](https://github.com/Samhuw8a/Examtracker/actions/workflows/test.yml/badge.svg) 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 ![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FSamhuw8a%2FExamtracker%2Fmaster%2Fpyproject.toml&color=d8634c)
@@ -53,6 +54,7 @@ By default, the program searches for:
 
 ```yaml
 database_path: "~/.config/examtracker/examtracker.db"
+database_uri: "sqllite:///~/.config/examtracker/examtracker.db"
 ```
 
 </details>
@@ -93,6 +95,7 @@ Environment variables override values defined in `config.yml`.
 - `id`
 - `name`
 - `semester_id`
+- `exam_grade`
 
 ### `semester`
 - `id`
@@ -102,10 +105,18 @@ Environment variables override values defined in `config.yml`.
 
 # TODO
 
+- [x] Allow for floating point values for the points scored
 - [x] Handle SQL errors  
 - [x] Initialize database  
 - [x] Configuration file support  
 - [x] Abort edit and add screens  
 - [x] Cross-platform config discovery  
-- [ ] Improve CSS  
+- [x] Improve CSS  
 - [x] enable Editing Exams and Semester
+- [x] Feature where you can add the grade you got in the exams
+- [ ] Enable externaly hosted database in config
+- [x] Add a Notes section to the Exams for adding notes
+- [  ] Fix sizing issue when removing a large note from an exam
+- [x] Save the collumn when entering a submenu to set the cursor to the same place as before instead of to the top
+- [x] write Tests
+- [x] automagicly push new pypi versions and make release upon github tag push tag push

{examtracker-1.2.1 → examtracker-1.2.3}/pyproject.toml

@@ -7,12 +7,12 @@ build-backend = "setuptools.build_meta" # If not defined, then legacy behavior c
 
 [project]
 name = "Examtracker" # REQUIRED, is the only field that cannot be marked as dynamic.
-version = "1.2.1" # REQUIRED, although can be dynamic
+version = "1.2.3" # REQUIRED, although can be dynamic
 description = "A Python exam tracker for the Lernphase .It allows you to keep track of all exams you have completed and the scores you achieved."
 
 readme = "README.md"
 
-requires-python = ">=3.13"
+requires-python = ">=3.10"
 license = { file = "LICENSE" }
 
 authors = [{ name = "Samuel Huwiler", email = "samuel.huwiler@gmx.ch" }]

{examtracker-1.2.1 → examtracker-1.2.3}/requirements.txt

@@ -5,3 +5,6 @@ pydantic
 pydantic-settings
 pathlib
 pyyaml
+rich
+pymysql
+cryptography

{examtracker-1.2.1 → examtracker-1.2.3/src/Examtracker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Examtracker
-Version: 1.2.1
+Version: 1.2.3
 Summary: A Python exam tracker for the Lernphase .It allows you to keep track of all exams you have completed and the scores you achieved.
 Author-email: Samuel Huwiler <samuel.huwiler@gmx.ch>
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
-Requires-Python: >=3.13
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: textual
@@ -35,8 +35,12 @@ Requires-Dist: pydantic
 Requires-Dist: pydantic-settings
 Requires-Dist: pathlib
 Requires-Dist: pyyaml
+Requires-Dist: rich
+Requires-Dist: pymysql
+Requires-Dist: cryptography
 Dynamic: license-file
 
+![test](https://github.com/Samhuw8a/Examtracker/actions/workflows/test.yml/badge.svg) 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 ![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FSamhuw8a%2FExamtracker%2Fmaster%2Fpyproject.toml&color=d8634c)
@@ -92,6 +96,7 @@ By default, the program searches for:
 
 ```yaml
 database_path: "~/.config/examtracker/examtracker.db"
+database_uri: "sqllite:///~/.config/examtracker/examtracker.db"
 ```
 
 </details>
@@ -132,6 +137,7 @@ Environment variables override values defined in `config.yml`.
 - `id`
 - `name`
 - `semester_id`
+- `exam_grade`
 
 ### `semester`
 - `id`
@@ -141,10 +147,18 @@ Environment variables override values defined in `config.yml`.
 
 # TODO
 
+- [x] Allow for floating point values for the points scored
 - [x] Handle SQL errors  
 - [x] Initialize database  
 - [x] Configuration file support  
 - [x] Abort edit and add screens  
 - [x] Cross-platform config discovery  
-- [ ] Improve CSS  
+- [x] Improve CSS  
 - [x] enable Editing Exams and Semester
+- [x] Feature where you can add the grade you got in the exams
+- [ ] Enable externaly hosted database in config
+- [x] Add a Notes section to the Exams for adding notes
+- [  ] Fix sizing issue when removing a large note from an exam
+- [x] Save the collumn when entering a submenu to set the cursor to the same place as before instead of to the top
+- [x] write Tests
+- [x] automagicly push new pypi versions and make release upon github tag push tag push

{examtracker-1.2.1 → examtracker-1.2.3}/src/Examtracker.egg-info/SOURCES.txt

@@ -21,4 +21,5 @@ src/examtracker/screens/classscreen.py
 src/examtracker/screens/examscreen.py
 src/examtracker/screens/inputscreens.py
 src/examtracker/screens/semesterscreen.py
-src/examtracker/textual_utils/vimtable.py
+src/examtracker/textual_utils/vimtable.py
+test/test_database.py

{examtracker-1.2.1 → examtracker-1.2.3}/src/Examtracker.egg-info/requires.txt

@@ -5,3 +5,6 @@ pydantic
 pydantic-settings
 pathlib
 pyyaml
+rich
+pymysql
+cryptography

{examtracker-1.2.1 → examtracker-1.2.3}/src/examtracker/app.py

@@ -1,6 +1,6 @@
 from sqlalchemy import Engine  # type:ignore
 from sqlalchemy.orm import Session
-from textual.app import App, ComposeResult
+from textual.app import App
 
 from examtracker.screens.semesterscreen import SemesterScreen
 from examtracker.settings import Settings
@@ -11,12 +11,11 @@ class ExamTracker(App):
         ("q", "quit", "Quit"),
         ("ctrl+c", "quit"),
     ]
-    # CSS_PATH = "/Users/samuel/Repositories/Examtracker/data/style.css"
-
-    def compose(self) -> ComposeResult:
-        yield SemesterScreen()
+    ENABLE_COMMAND_PALETTE = False
+    # CSS_PATH = "/Users/samuel/Repositories/Examtracker/src/examtracker/data/style.css"
 
     def on_mount(self) -> None:
+        self.theme = "gruvbox"
         self.push_screen(SemesterScreen())
         self.stylesheet.read(self.config.css_path)
 

examtracker-1.2.3/src/examtracker/data/style.css

@@ -0,0 +1,44 @@
+DataTable {
+    border-title-align: center;
+    border-title-style: bold;
+    border-title-color: $foreground;
+    margin: 3;
+    padding: 2;
+    width: 75%;
+    border: white;
+    text-style: bold;
+}
+
+
+DataTable .datatable--header {
+    text-style: bold;
+    background: $primary;
+    color: black;
+}
+
+DataTable .datatable--cursor {
+    background: $accent 60%;
+    text-style: italic underline;
+}
+
+Screen {
+    position: relative;
+    align: center top;
+    margin: 3;
+}
+
+Vertical {
+    margin: 5;
+    align: center top;
+    width: 75%;
+}
+
+Input {
+    width: 75%;
+}
+
+
+Label {
+    width: 75%;
+    padding: 1;
+}

{examtracker-1.2.1 → examtracker-1.2.3}/src/examtracker/database.py

@@ -2,20 +2,19 @@
 Database related functions for getting and adding entries
 """
 
-from typing import List
+from typing import Optional
 
-from sqlalchemy import Engine, create_engine, inspect  # type:ignore
+from sqlalchemy import Engine  # type:ignore
 from sqlalchemy.orm import Session
 
 from examtracker.database_scheme import Base, Class, Exam, Semester
 
 
-def create_database_engine(path: str) -> Engine:
-    engine = create_engine("sqlite:///" + path, echo=False)
-    inspector = inspect(engine)
+def create_database_engine(uri: str) -> Engine:
+    from sqlalchemy import create_engine
 
-    if not inspector.get_table_names():
-        create_tables(engine)
+    engine = create_engine(uri, echo=False)
+    create_tables(engine)
 
     return engine
 
@@ -31,7 +30,7 @@ def get_semester_by_name(session: Session, name: str) -> Semester:
 def add_semester(session: Session, name: str) -> None:
     semester_obj = Semester(name=name)
     session.add(semester_obj)
-    session.flush
+    session.flush()
 
 
 def get_class_by_id(session: Session, class_id: int) -> Class:
@@ -43,37 +42,48 @@ def get_exam_by_id(session: Session, exam_id: int) -> Exam:
 
 
 def add_class_to_semester(
-    session: Session, class_name: str, semster_obj: Semester
+    session: Session,
+    class_name: str,
+    semster_obj: Semester,
+    exam_grade: Optional[float] = None,
 ) -> None:
-    class_obj = Class(name=class_name, semester_id=semster_obj.semester_id)
+    class_obj = Class(
+        name=class_name, semester_id=semster_obj.semester_id, exam_grade=exam_grade
+    )
     session.add(class_obj)
     session.flush()
 
 
 def add_exam_to_class(
-    session: Session, name: str, max_points: int, scored_points: int, class_obj: Class
+    session: Session,
+    name: str,
+    max_points: float,
+    scored_points: float,
+    notes: str,
+    class_obj: Class,
 ) -> None:
     exam_obj = Exam(
         name=name,
         max_points=max_points,
         scored_points=scored_points,
+        notes=notes,
         class_id=class_obj.class_id,
     )
     session.add(exam_obj)
     session.flush()
 
 
-def get_all_exams_for_class(session: Session, class_obj: Class) -> List[Exam]:
+def get_all_exams_for_class(session: Session, class_obj: Class) -> list[Exam]:
     return session.query(Exam).filter_by(class_id=class_obj.class_id).all()
 
 
-def get_all_semester(session: Session) -> List[Semester]:
-    return session.query(Semester).all()
+def get_all_semester(session: Session) -> list[Semester]:
+    return session.query(Semester).all()[::-1]
 
 
 def get_all_classes_for_semester(
     session: Session, semster_obj: Semester
-) -> List[Class]:
+) -> list[Class]:
     return session.query(Class).filter_by(semester_id=semster_obj.semester_id).all()
 
 
@@ -93,15 +103,16 @@ def remove_exam_by_id(session: Session, exam_id: int) -> None:
 
 
 def main() -> int:
-    engine: Engine = create_database_engine("test.db")
-    # create_tables(engine)
+    engine: Engine = create_database_engine("sqlite:///test.db")
+    create_tables(engine)
     session = Session(engine)
-    # # add_semester(session, "FS25")
+    add_semester(session, "FS25")
     # # remove_semester_by_name(session, "FS25")
     # # print(get_all_semester(session))
-    # sem = get_semester_by_name(session, "HS24")
-    # add_class_to_semester(session, "Eprog", sem)
-    # # cls = get_class_by_name(session,"Eprog")
+    sem = get_semester_by_name(session, "FS25")
+    add_class_to_semester(session, "wEprog", sem)
+    cls = get_all_classes_for_semester(session, sem)[0]
+    print(cls.exam_grade)
     # # print(get_all_exams_for_class(session, cls))
     session.commit()
     return 0

{examtracker-1.2.1 → examtracker-1.2.3}/src/examtracker/database_scheme.py

@@ -2,12 +2,10 @@
 Defining the database tables and entries
 """
 
-from typing import List
-
 from sqlalchemy import ForeignKey, String
-from sqlalchemy.orm import (
+from sqlalchemy.orm import (  # type: ignore
     DeclarativeBase,
-    Mapped,  # type:ignore
+    Mapped,
     mapped_column,
     relationship,
 )
@@ -21,8 +19,9 @@ class Exam(Base):
     __tablename__ = "exams"
     exam_id: Mapped[int] = mapped_column(primary_key=True)
     name: Mapped[str] = mapped_column(String(30))
-    max_points: Mapped[int]
-    scored_points: Mapped[int]
+    max_points: Mapped[float]
+    scored_points: Mapped[float]
+    notes: Mapped[str] = mapped_column(String(100))
     class_id: Mapped[int] = mapped_column(ForeignKey("classes.class_id"))
     class_: Mapped["Class"] = relationship(back_populates="exams")  # type:ignore
 
@@ -34,10 +33,11 @@ class Class(Base):
     __tablename__ = "classes"
     class_id: Mapped[int] = mapped_column(primary_key=True)
     name: Mapped[str] = mapped_column(String(30))
+    exam_grade: Mapped[float | None]
     semester_id: Mapped[int] = mapped_column(ForeignKey("semester.semester_id"))
     semester: Mapped["Semester"] = relationship(back_populates="classes")  # type:ignore
 
-    exams: Mapped[List["Exam"]] = relationship(
+    exams: Mapped[list["Exam"]] = relationship(
         back_populates="class_",
         cascade="all, delete-orphan",
     )  # type: ignore
@@ -50,7 +50,7 @@ class Semester(Base):
     __tablename__ = "semester"
     semester_id: Mapped[int] = mapped_column(primary_key=True)
     name: Mapped[str] = mapped_column(String(30), unique=True)
-    classes: Mapped[List["Class"]] = relationship(
+    classes: Mapped[list["Class"]] = relationship(
         back_populates="semester",
         cascade="all, delete-orphan",
     )  # type: ignore

{examtracker-1.2.1 → examtracker-1.2.3}/src/examtracker/main.py

@@ -7,7 +7,7 @@ from examtracker.settings import Settings
 
 def main() -> int:
     config: Settings = Settings()
-    db_engine = create_database_engine(config.database_path)
+    db_engine = create_database_engine(config.database_uri)
     app = ExamTracker(db_engine, config)
     app.run()
     return 0

{examtracker-1.2.1 → examtracker-1.2.3}/src/examtracker/screens/classscreen.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import math
+
 from sqlalchemy.orm import Session
 from textual import on
 from textual.app import ComposeResult, Screen
@@ -13,57 +15,75 @@ from examtracker.database import (
     remove_class_by_id,
 )
 from examtracker.screens.examscreen import ExamScreen
-from examtracker.screens.inputscreens import SingleInputScreen
+from examtracker.screens.inputscreens import MultiInputScreen
 from examtracker.textual_utils.vimtable import VimTable
 
 
-class AddClassScreen(SingleInputScreen):
-
+class AddClassScreen(MultiInputScreen):
     def __init__(self, semester_name: str, **kwargs) -> None:
-        super().__init__(**kwargs)
+        super().__init__(2, **kwargs)
         self.semester_name = semester_name
         self.label_text = f"Add class to: {self.semester_name}"
 
     def on_mount(self) -> None:
-        self.input_button.placeholder = "class name"
-        self.input_button.value = ""
-        self.input_button.focus()
+        self.buttons[0].placeholder = "class name"
+        self.buttons[0].value = ""
+        self.buttons[1].placeholder = "exam_score"
+        self.buttons[1].value = ""
+        self.buttons[0].focus()
 
     # Submit on Enter from any Input
     def submit(self) -> None:
-        name = self.input_button.value.strip()
+        name = self.buttons[0].value.strip()
+        exam_score = self.buttons[1].value.strip()
+        try:
+            score = float(exam_score)
+        except ValueError:
+            score = None
         if not name:
             return  # Require class name
         semester = get_semester_by_name(self.db_session, self.semester_name)
         # Add the class
-        add_class_to_semester(self.db_session, name, semester)  # type: ignore
+        add_class_to_semester(self.db_session, name, semester, score)  # type: ignore
         self.db_session.commit()
 
         # Pop the screen and return
         self.app.pop_screen()
 
 
-class EditClassScreen(SingleInputScreen):
-
+class EditClassScreen(MultiInputScreen):
     def __init__(self, class_id: int, **kwargs) -> None:
-        super().__init__(**kwargs)
+        super().__init__(2, **kwargs)
         self.class_id = class_id
         self.label_text = "Edit class"
 
     def on_mount(self) -> None:
         class_obj = get_class_by_id(self.db_session, self.class_id)
-        self.input_button.value = class_obj.name
-        self.input_button.focus()
+        self.buttons[0].value = class_obj.name
+        if class_obj.exam_grade is not None:
+            self.buttons[1].value = str(class_obj.exam_grade)
+        else:
+            self.buttons[1].value = ""
+        self.buttons[0].focus()
 
     # Submit on Enter from any Input
     def submit(self) -> None:
-        name = self.input_button.value.strip()
+        name = self.buttons[0].value.strip()
+        exam_score = self.buttons[1].value.strip()
+        try:
+            score = float(exam_score)
+        except ValueError:
+            score = None
+
+        if isinstance(score, float) and not math.isfinite(score):
+            score = None
         if not name:
             return  # Require class name
 
         class_obj = get_class_by_id(self.db_session, self.class_id)
         # Add the class
         class_obj.name = name
+        class_obj.exam_grade = score
         self.db_session.commit()
 
         # Pop the screen and return
@@ -86,11 +106,12 @@ class ClassScreen(Screen):
         super().__init__()
         self.db_session: Session = self.app.db_session  # type: ignore
         self.semester_name = semester_name
+        self.latest_row = 0
 
     def compose(self) -> ComposeResult:
         yield Header()
         self.class_table: VimTable = VimTable()
-        self.class_table.add_columns("ID", "Name")
+        self.class_table.add_columns("ID", "Name", "Exam grade")
         self.class_table.cursor_type = "row"
         self.class_table.border_title = f"classes for: {self.semester_name}"
         yield self.class_table
@@ -129,7 +150,13 @@ class ClassScreen(Screen):
 
         self.class_table.clear()
         for cls in get_all_classes_for_semester(self.db_session, semester):
-            self.class_table.add_row(cls.class_id, cls.name)
+            score = cls.exam_grade
+            str_score = ""
+            if score is not None:
+                str_score = str(cls.exam_grade)
+            self.class_table.add_row(cls.class_id, cls.name, str_score)
+
+        self.class_table.move_cursor(row=self.latest_row, column=0)
 
     def on_screen_resume(self) -> None:
         self.refresh_table()
@@ -139,6 +166,7 @@ class ClassScreen(Screen):
         row_index = self.class_table.cursor_row
         if row_index is None:
             return
+        self.latest_row = row_index
 
         class_id = self.class_table.get_row_at(row_index)[0]
         self.app.push_screen(ExamScreen(class_id))