chore refactor

.github/workflows/mypy.yml

@@ -0,0 +1,26 @@
+name: Mypy
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Mypy
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install Dependencies
+        run: |
+          pip install -r requirements.txt
+      - name: mypy
+        run: |
+          mypy

README.md

@@ -50,7 +50,7 @@ All notes are imported to the cloze type. Any bold text, notated by markdown `**
 fields.
 
 By default, cloze fields will be numbered in the order they appear in the note. To manually number cloze fields, use
-`{{c#::text}}`. The automatic counting will be reset to the number following the `#`.
+`{{c#::text}}`. The automatic counting does not increment in this case.
 
 ## New card syntax
 
@@ -106,16 +106,11 @@ Text:
 Extra:
 
 > * Land Ordinance Act of 1785
-    >
-
-* allowed federal government to sell western lands
-
-> * pay off national debt
+>   * allowed federal government to sell western lands
+>   * pay off national debt
 >   * organize new lands into townships and public schools
 > * Northwest Ordinance of 1787
-    >
-
-* provided that when new territory reached population of 60K → could apply for statehood with no slavery allowed
+>   * provided that when new territory reached population of 60K → could apply for statehood with no slavery allowed
 
 # How it works 🛠️
 
@@ -124,4 +119,9 @@ processed. If the file has already been processed, it will be skipped.
 
 # Contributing 🤝
 
-Feel free to contribute to this project by opening an issue or creating a pull request!
+Feel free to contribute to this project by opening an issue or creating a pull request!
+
+If adding a package, please run ` pip freeze > requirements.txt` to update the requirements.txt file.
+
+Please ensure that code is typed properly with `mypy`
+

mypy.ini

@@ -0,0 +1,3 @@
+[mypy]
+mypy_path = src
+files = src/main.py