refactor: fix import errors after folder restructure (#202)

Auto-created --------- Co-authored-by: github-actions <[email protected]>
MartinBernstorff · Nov 19, 2023 · 5680ad9 · 5680ad9
1 parent 6a9e7fb
commit 5680ad9
Show file tree

Hide file tree

Showing 36 changed files with 152 additions and 137 deletions.
diff --git a/.github/workflows/stalebot.yml b/.github/workflows/stalebot.yml
@@ -10,8 +10,8 @@ jobs:
     steps:
       - uses: actions/stale@v6
         with:
-          days-before-issue-stale: 14
-          days-before-issue-close: 7
+          days-before-issue-stale: 9999
+          days-before-issue-close: 9999
           stale-issue-message: "This issue is stale because it has been open for 14 days with no activity. Feel free to either 1) remove the stale label or 2) comment. If nothing happens, this will be closed in 7 days."
           close-issue-message: "This issue was closed automatically. Feel free to re-open it if it's important."
           days-before-pr-stale: 2

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -6,16 +6,5 @@
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "explorer.excludeGitIgnore": false,
-    "files.exclude": {
-        "**/.git": true,
-        "**/.svn": true,
-        "**/.hg": true,
-        "**/CVS": true,
-        "**/.DS_Store": true,
-        "**/Thumbs.db": true,
-        "**/BUILD": true,
-        "*.egg-info": true,
-        "*.pytest_cache": true,
-    },
     "python.analysis.diagnosticMode": "workspace"
 }
diff --git a/makefile b/makefile
@@ -1,5 +1,9 @@
 SRC_PATH = personal_mnemonic_medium
 
+# TODO: https://github.com/MartinBernstorff/personal-mnemonic-medium/issues/205 Decrease makefile verbosity
+# E.g. entering/leaving directory
+# Or showing each command when running make pr
+
 deploy:
 	./docker_cmd.sh
 
@@ -14,24 +18,24 @@ install:
 	pip install -e .
 
 test: ## Run tests
-	pytest personal_mnemonic_medium/tests
+	pytest personal_mnemonic_medium
 
 test-cov: ## Run tests with coverage
 	# TODO: https://github.com/MartinBernstorff/personal-mnemonic-medium/issues/209 Fix coverage and add it to make pr
-	pytest --cov=personal_mnemonic_medium --cov-report=term-missing personal_mnemonic_medium/tests
+	pytest --cov=personal_mnemonic_medium --cov-report=term-missing personal_mnemonic_medium
 
 lint: ## Format code
 	ruff format . 
 	ruff . --fix \
 		--extend-select F401 \
 		--extend-select F841
 
-type-check: ## Type-check code
+types: ## Type-check code
 	pyright $(SRC_PATH)
 
 validate: ## Run all checks
 	make lint
-	make type-check
+	make types
 	make test
 
 merge-main:

diff --git a/...nal_mnemonic_medium/exporters/__init__.py → ...l_mnemonic_medium/data_access/__init__.py b/...nal_mnemonic_medium/exporters/__init__.py → ...l_mnemonic_medium/data_access/__init__.py
diff --git a/...nemonic_medium/exporters/anki/__init__.py → ...ata_access/document_ingesters/__init__.py b/...nemonic_medium/exporters/anki/__init__.py → ...ata_access/document_ingesters/__init__.py
diff --git a/...al_mnemonic_medium/note_factories/base.py → ...um/data_access/document_ingesters/base.py b/...al_mnemonic_medium/note_factories/base.py → ...um/data_access/document_ingesters/base.py
@@ -2,7 +2,9 @@
 from collections.abc import Sequence
 from pathlib import Path
 
-from personal_mnemonic_medium.note_factories.note import Document
+from personal_mnemonic_medium.data_access.document_ingesters.document import (
+    Document,
+)
 
 
 class DocumentFactory(ABC):

diff --git a/...al_mnemonic_medium/note_factories/note.py → ...ata_access/document_ingesters/document.py b/...al_mnemonic_medium/note_factories/note.py → ...ata_access/document_ingesters/document.py
diff --git a/...nemonic_medium/note_factories/markdown.py → ...s/document_ingesters/markdown_ingester.py b/...nemonic_medium/note_factories/markdown.py → ...s/document_ingesters/markdown_ingester.py
@@ -5,10 +5,12 @@
 
 from tqdm import tqdm
 
-from personal_mnemonic_medium.note_factories.base import (
+from personal_mnemonic_medium.data_access.document_ingesters.base import (
     DocumentFactory,
 )
-from personal_mnemonic_medium.note_factories.note import Document
+from personal_mnemonic_medium.data_access.document_ingesters.document import (
+    Document,
+)
 
 
 class MarkdownNoteFactory(DocumentFactory):

diff --git a/...nemonic_medium/note_factories/__init__.py → ..._medium/data_access/exporters/__init__.py b/...nemonic_medium/note_factories/__init__.py → ..._medium/data_access/exporters/__init__.py
diff --git a/personal_mnemonic_medium/data_access/exporters/anki/__init__.py b/personal_mnemonic_medium/data_access/exporters/anki/__init__.py
diff --git a/...nemonic_medium/exporters/anki/anki_css.py → ...um/data_access/exporters/anki/anki_css.py b/...nemonic_medium/exporters/anki/anki_css.py → ...um/data_access/exporters/anki/anki_css.py
diff --git a/..._medium/exporters/anki/card_types/base.py → ..._access/exporters/anki/card_types/base.py b/..._medium/exporters/anki/card_types/base.py → ..._access/exporters/anki/card_types/base.py
@@ -8,14 +8,18 @@
 
 import genanki
 
-from personal_mnemonic_medium.exporters.markdown_to_html.html_compiler import (
+from personal_mnemonic_medium.data_access.document_ingesters.document import (
+    Document,
+)
+from personal_mnemonic_medium.domain.markdown_to_html import (
     compile_field,
 )
-from personal_mnemonic_medium.exporters.url_generators.obsidian_url import (
+from personal_mnemonic_medium.domain.prompt_extractors.prompt import (
+    Prompt,
+)
+from personal_mnemonic_medium.domain.url_generators.obsidian_url import (
     get_obsidian_url,
 )
-from personal_mnemonic_medium.note_factories.note import Document
-from personal_mnemonic_medium.prompt_extractors.prompt import Prompt
 
 
 class AnkiCard(ABC):

diff --git a/...medium/exporters/anki/card_types/cloze.py → ...access/exporters/anki/card_types/cloze.py b/...medium/exporters/anki/card_types/cloze.py → ...access/exporters/anki/card_types/cloze.py
@@ -4,17 +4,21 @@
 
 import genanki
 
-from personal_mnemonic_medium.exporters.anki.card_types.base import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.base import (
     AnkiCard,
 )
-from personal_mnemonic_medium.exporters.anki.globals import CONFIG
-from personal_mnemonic_medium.exporters.markdown_to_html.html_compiler import (
+from personal_mnemonic_medium.data_access.exporters.anki.globals import (
+    CONFIG,
+)
+from personal_mnemonic_medium.domain.markdown_to_html import (
     compile_field,
 )
-from personal_mnemonic_medium.exporters.url_generators.obsidian_url import (
+from personal_mnemonic_medium.domain.prompt_extractors.prompt import (
+    Prompt,
+)
+from personal_mnemonic_medium.domain.url_generators.obsidian_url import (
     get_obsidian_url,
 )
-from personal_mnemonic_medium.prompt_extractors.prompt import Prompt
 from personal_mnemonic_medium.utils.hasher import simple_hash
 
 

diff --git a/...ic_medium/exporters/anki/card_types/qa.py → ...ta_access/exporters/anki/card_types/qa.py b/...ic_medium/exporters/anki/card_types/qa.py → ...ta_access/exporters/anki/card_types/qa.py
@@ -2,19 +2,22 @@
 from pathlib import Path
 
 import genanki
-from personal_mnemonic_medium.exporters.anki.card_types.base import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.base import (
     AnkiCard,
 )
-from personal_mnemonic_medium.exporters.anki.globals import CONFIG
-from personal_mnemonic_medium.exporters.markdown_to_html.html_compiler import (
+from personal_mnemonic_medium.domain.markdown_to_html import (
     compile_field,
 )
-from personal_mnemonic_medium.exporters.url_generators.obsidian_url import (
+from personal_mnemonic_medium.domain.url_generators.obsidian_url import (
     get_obsidian_url,
 )
-from personal_mnemonic_medium.prompt_extractors.prompt import Prompt
+from personal_mnemonic_medium.domain.prompt_extractors.prompt import (
+    Prompt,
+)
 from personal_mnemonic_medium.utils.hasher import simple_hash
-from personal_mnemonic_medium.exporters.anki.globals import CONFIG  # noqa
+from personal_mnemonic_medium.data_access.exporters.anki.globals import (  # noqa
+    CONFIG,
+)
 
 
 class AnkiQA(AnkiCard):
@@ -39,12 +42,13 @@ def genanki_model(self) -> genanki.Model:
         global CONFIG  # noqa
         return genanki.Model(
             model_id=simple_hash(CONFIG["card_model_name_qa"]),  # type: ignore
-            name=CONFIG["card_model_name_qa"],
-            fields=CONFIG["card_model_fields_qa"],
-            templates=CONFIG["card_model_template_qa"],
+            name=CONFIG["card_model_name_qa"],  # type: ignore
+            fields=CONFIG["card_model_fields_qa"],  # type: ignore
+            templates=CONFIG["card_model_template_qa"],  # type: ignore
             css=CONFIG["card_model_css"],  # type: ignore
             model_type=0,
         )
+        # TODO: https://github.com/MartinBernstorff/personal-mnemonic-medium/issues/203 Refactor the CONFIG to be a dataclass
 
     @property
     def card_uuid(self) -> int:

diff --git a/...ium/tests/test_md_files/test_card_guid.md → ...s/exporters/anki/card_types/test_cards.md b/...ium/tests/test_md_files/test_card_guid.md → ...s/exporters/anki/card_types/test_cards.md
diff --git a/...sts/exporters/anki/test_card_converter.py → ...s/exporters/anki/card_types/test_cards.py b/...sts/exporters/anki/test_card_converter.py → ...s/exporters/anki/card_types/test_cards.py
@@ -1,31 +1,35 @@
 from collections.abc import Sequence
 from pathlib import Path
 
-from personal_mnemonic_medium.card_pipeline import CardPipeline
-from personal_mnemonic_medium.exporters.anki.card_types.base import (
+from personal_mnemonic_medium.data_access.document_ingesters.base import (
+    DocumentFactory,
+)
+from personal_mnemonic_medium.data_access.document_ingesters.document import (
+    Document,
+)
+from personal_mnemonic_medium.data_access.document_ingesters.markdown_ingester import (
+    MarkdownNoteFactory,
+)
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.base import (
     AnkiCard,
 )
-from personal_mnemonic_medium.exporters.anki.card_types.qa import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.qa import (
     AnkiQA,
 )
-from personal_mnemonic_medium.exporters.anki.package_generator import (
+from personal_mnemonic_medium.data_access.exporters.anki.package_generator import (
     AnkiPackageGenerator,
 )
-from personal_mnemonic_medium.exporters.base import CardExporter
-from personal_mnemonic_medium.note_factories.base import (
-    DocumentFactory,
-)
-from personal_mnemonic_medium.note_factories.markdown import (
-    MarkdownNoteFactory,
+from personal_mnemonic_medium.data_access.exporters.base import (
+    CardExporter,
 )
-from personal_mnemonic_medium.note_factories.note import Document
-from personal_mnemonic_medium.prompt_extractors.base import (
+from personal_mnemonic_medium.domain.card_pipeline import CardPipeline
+from personal_mnemonic_medium.domain.prompt_extractors.base import (
     PromptExtractor,
 )
-from personal_mnemonic_medium.prompt_extractors.cloze_extractor import (
+from personal_mnemonic_medium.domain.prompt_extractors.cloze_extractor import (
     ClozePromptExtractor,
 )
-from personal_mnemonic_medium.prompt_extractors.qa_extractor import (
+from personal_mnemonic_medium.domain.prompt_extractors.qa_extractor import (
     QAPrompt,
     QAPromptExtractor,
 )
@@ -91,11 +95,8 @@ def test_get_subtags():
 
 
 def test_qa_uuid_generation():
-    file_path = (
-        Path(__file__).parent.parent.parent
-        / "test_md_files"
-        / "test_card_guid.md"
-    )
+    # TODO: https://github.com/MartinBernstorff/personal-mnemonic-medium/issues/204 Remove dependency on test_md_files
+    file_path = Path(__file__).parent / "test_cards.md"
     cards = MockCardPipeline(
         prompt_extractors=[QAPromptExtractor()]
     ).run(input_path=file_path)
@@ -109,11 +110,7 @@ def test_qa_uuid_generation():
 
 
 def test_cloze_uuid_generation():
-    file_path = (
-        Path(__file__).parent.parent.parent
-        / "test_md_files"
-        / "test_card_guid.md"
-    )
+    file_path = Path(__file__).parent / "test_cards.md"
     cloze_cards = MockCardPipeline(
         prompt_extractors=[ClozePromptExtractor()]
     ).run(input_path=file_path)

diff --git a/...mnemonic_medium/exporters/anki/globals.py → ...ium/data_access/exporters/anki/globals.py b/...mnemonic_medium/exporters/anki/globals.py → ...ium/data_access/exporters/anki/globals.py
@@ -2,7 +2,7 @@
 import textwrap
 from typing import Any
 
-from personal_mnemonic_medium.exporters.anki.anki_css import (
+from personal_mnemonic_medium.data_access.exporters.anki.anki_css import (
     CARD_MODEL_CSS,
 )
 

diff --git a/...edium/exporters/anki/package_generator.py → ...ccess/exporters/anki/package_generator.py b/...edium/exporters/anki/package_generator.py → ...ccess/exporters/anki/package_generator.py
@@ -11,21 +11,25 @@
 
 import genanki
 
-from personal_mnemonic_medium.exporters.anki.card_types.base import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.base import (
     AnkiCard,
 )
-from personal_mnemonic_medium.exporters.anki.card_types.cloze import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.cloze import (
     AnkiCloze,
 )
-from personal_mnemonic_medium.exporters.anki.card_types.qa import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.qa import (
     AnkiQA,
 )
-from personal_mnemonic_medium.exporters.base import CardExporter
-from personal_mnemonic_medium.prompt_extractors.cloze_extractor import (
+from personal_mnemonic_medium.data_access.exporters.base import (
+    CardExporter,
+)
+from personal_mnemonic_medium.domain.prompt_extractors.cloze_extractor import (
     ClozePrompt,
 )
-from personal_mnemonic_medium.prompt_extractors.prompt import Prompt
-from personal_mnemonic_medium.prompt_extractors.qa_extractor import (
+from personal_mnemonic_medium.domain.prompt_extractors.prompt import (
+    Prompt,
+)
+from personal_mnemonic_medium.domain.prompt_extractors.qa_extractor import (
     QAPrompt,
 )
 from personal_mnemonic_medium.utils.hasher import simple_hash

diff --git a/...al_mnemonic_medium/exporters/anki/sync.py → ...medium/data_access/exporters/anki/sync.py b/...al_mnemonic_medium/exporters/anki/sync.py → ...medium/data_access/exporters/anki/sync.py
@@ -8,10 +8,10 @@
 from genanki import Model, Note
 from wasabi import Printer
 
-from personal_mnemonic_medium.exporters.anki.globals import (
+from personal_mnemonic_medium.data_access.exporters.anki.globals import (
     ANKICONNECT_URL,
 )
-from personal_mnemonic_medium.exporters.anki.package_generator import (
+from personal_mnemonic_medium.data_access.exporters.anki.package_generator import (
     DeckBundle,
 )
 

diff --git a/.../exporters/anki/test_package_generator.py → .../exporters/anki/test_package_generator.py b/.../exporters/anki/test_package_generator.py → .../exporters/anki/test_package_generator.py
@@ -1,16 +1,18 @@
 from pathlib import Path
 
-from personal_mnemonic_medium.exporters.anki.card_types.base import (
+from personal_mnemonic_medium.data_access.document_ingesters.document import (
+    Document,
+)
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.base import (
     AnkiCard,
 )
-from personal_mnemonic_medium.exporters.anki.card_types.qa import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.qa import (
     AnkiQA,
 )
-from personal_mnemonic_medium.exporters.anki.package_generator import (
+from personal_mnemonic_medium.data_access.exporters.anki.package_generator import (
     AnkiPackageGenerator,
 )
-from personal_mnemonic_medium.note_factories.note import Document
-from personal_mnemonic_medium.prompt_extractors.qa_extractor import (
+from personal_mnemonic_medium.domain.prompt_extractors.qa_extractor import (
     QAPrompt,
 )
 

diff --git a/personal_mnemonic_medium/exporters/base.py → ...onic_medium/data_access/exporters/base.py b/personal_mnemonic_medium/exporters/base.py → ...onic_medium/data_access/exporters/base.py
@@ -1,10 +1,12 @@
 from abc import ABC, abstractmethod
 from collections.abc import Sequence
 
-from personal_mnemonic_medium.exporters.anki.card_types.base import (
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.base import (
     AnkiCard,
 )
-from personal_mnemonic_medium.prompt_extractors.prompt import Prompt
+from personal_mnemonic_medium.domain.prompt_extractors.prompt import (
+    Prompt,
+)
 
 
 class CardExporter(ABC):

diff --git a/personal_mnemonic_medium/card_pipeline.py → ...l_mnemonic_medium/domain/card_pipeline.py b/personal_mnemonic_medium/card_pipeline.py → ...l_mnemonic_medium/domain/card_pipeline.py
@@ -1,18 +1,24 @@
 from collections.abc import Sequence
 from pathlib import Path
 
-from personal_mnemonic_medium.exporters.anki.card_types.base import (
+from personal_mnemonic_medium.data_access.document_ingesters.base import (
+    DocumentFactory,
+)
+from personal_mnemonic_medium.data_access.document_ingesters.document import (
+    Document,
+)
+from personal_mnemonic_medium.data_access.exporters.anki.card_types.base import (
     AnkiCard,
 )
-from personal_mnemonic_medium.exporters.base import CardExporter
-from personal_mnemonic_medium.note_factories.base import (
-    DocumentFactory,
+from personal_mnemonic_medium.data_access.exporters.base import (
+    CardExporter,
 )
-from personal_mnemonic_medium.note_factories.note import Document
-from personal_mnemonic_medium.prompt_extractors.base import (
+from personal_mnemonic_medium.domain.prompt_extractors.base import (
     PromptExtractor,
 )
-from personal_mnemonic_medium.prompt_extractors.prompt import Prompt
+from personal_mnemonic_medium.domain.prompt_extractors.prompt import (
+    Prompt,
+)
 
 
 class CardPipeline: