Start creating sync to Jira

Author: Tomáš Bouška

.python-version

@@ -0,0 +1 @@
+3.12.1

README.md

@@ -77,7 +77,11 @@ It used to be done automatically by direnv, but in some cases I needed to work w
 
 The scripts are using `buvis-pybase` and `doogat-core` which I'm also developing. Unfortunately, there is currently no easy way to use editable and non-editable packages in same `pyproject.toml` (see: https://github.com/python-poetry/poetry/issues/8219). So I need to modify `pyproject.toml`.
 
-1. Uncomment `# buvis-pybase = {path = "../buvis-pybase", develop = true}` in `pyproject.toml`
+1. Switch to local files:
+   - macOS: Uncomment `# buvis-pybase = {path = "../buvis-pybase", develop = true}` or `# doogat-core = {path = "../../doogat/doogat-core", develop = true}` in `pyproject.toml`
+   - Windows (there is an issue in Poetry in Windows causing it to be unable to resolve pth files):
+     - in scripts root: `pip install -e ../buvis-pybase/` or `pip install -e ..\..\doogat\doogat-core\`
+     - in script's root (like `src/bim` for example): `pip install -e ../../../buvis-pybase/` or `pip install -e ..\..\..\..\doogat\doogat-core\`
 2. Update dependencies: `poetry update`
 3. Do the work in both projects
 4. When done, you push to `buvis-pybase` project first

pyproject.toml

@@ -9,14 +9,14 @@ package-mode = false
 [tool.poetry.dependencies]
 python = "^3.12"
 # buvis-pybase = "0.1.3"
-buvis-pybase = {version = "0.1.5a5", source = "test-pypi"}
-# buvis-pybase = {path = "../buvis-pybase", develop = true}
+# buvis-pybase = {version = "0.1.5a5", source = "test-pypi"}
+buvis-pybase = {path = "../buvis-pybase", develop = true}
 
 [tool.poetry.group.dev.dependencies]
 click = "8.1.7"
 # doogat-core = "0.1.2"
-doogat-core = {version = "0.1.3a26", source = "test-pypi"}
-# doogat-core = {path = "../../doogat/doogat-core", develop = true}
+# doogat-core = {version = "0.1.3a26", source = "test-pypi"}
+doogat-core = {path = "../../doogat/doogat-core", develop = true}
 pre-commit = "4.0.1"
 pyfiglet = "1.0.2"
 ping3 = "4.0.8"

src/bim/bim/cli.py

@@ -6,15 +6,15 @@
 from buvis.pybase.adapters import console
 from buvis.pybase.configuration import Configuration
 
-from bim.commands import CommandFormatNote, CommandImportNote, CommandParseTags
+from bim.commands import CommandFormatNote, CommandImportNote, CommandParseTags, CommandSyncNote
 
 try:
     cfg = Configuration(Path(__file__, "../../config.yaml"))
 except FileNotFoundError:
     cfg = Configuration()
 
 
-@click.group(help="CLI to BUVIS InforMesh")
+@click.group(help="CLI to BUVIS InfoMesh")
 def cli() -> None:
     pass
 
@@ -75,6 +75,23 @@ def format_note(
         console.failure(f"{path_to_note} doesn't exist")
 
 
+@cli.command("sync", help="Synchronize note with external system")
+@click.argument("path_to_note")
+@click.argument("target_system")
+def sync_note(
+    path_to_note: Path,
+    target_system: str,
+) -> None:
+    if Path(path_to_note).is_file():
+        cfg.set_configuration_item("path_note", path_to_note)
+        cfg.set_configuration_item("target_system", target_system)
+        buvis_cfg = Configuration()
+        cfg.set_configuration_item("jira_adapter", buvis_cfg.get_configuration_item("jira_adapter"))
+        cmd = CommandSyncNote(cfg)
+        cmd.execute()
+    else:
+        console.failure(f"{path_to_note} doesn't exist")
+
 @cli.command("parse_tags", help="Parse Obsidian Metadata Extractor tags.json")
 @click.argument("path_to_tags_json")
 @click.option(

src/bim/bim/commands/__init__.py

@@ -1,5 +1,6 @@
 from .format_note.format_note import CommandFormatNote
 from .import_note.import_note import CommandImportNote
 from .parse_tags.parse_tags import CommandParseTags
+from .sync_note.sync_note import CommandSyncNote
 
-__all__ = ["CommandFormatNote", "CommandImportNote", "CommandParseTags"]
+__all__ = ["CommandFormatNote", "CommandImportNote", "CommandParseTags", "CommandSyncNote"]

src/bim/bim/commands/sync_note/sync_note.py

@@ -0,0 +1,76 @@
+from pathlib import Path
+
+from buvis.pybase.adapters import console, JiraAdapter
+from buvis.pybase.configuration import Configuration, ConfigurationKeyNotFoundError
+from doogat.core import (
+    MarkdownZettelFormatter,
+    MarkdownZettelRepository,
+    ReadDoogatUseCase,
+)
+
+
+class CommandSyncNote:
+    def __init__(self: "CommandSyncNote", cfg: Configuration) -> None:
+        try:
+            path_note = Path(str(cfg.get_configuration_item("path_note")))
+            if not path_note.is_file():
+                raise FileNotFoundError
+            self.path_note = path_note
+        except ConfigurationKeyNotFoundError as e:
+            raise FileNotFoundError from e
+
+        match cfg.get_configuration_item("target_system"):
+            case "jira":
+                self._target = JiraAdapter(cfg.get_configuration_item("jira_adapter"))
+            case _:
+                raise NotImplementedError
+        self._cfg = cfg
+
+
+    def execute(self: "CommandSyncNote") -> None:
+        repo = MarkdownZettelRepository()
+        reader = ReadDoogatUseCase(repo)
+        formatter = MarkdownZettelFormatter()
+        note = reader.execute(str(self.path_note))
+
+        defaults = self._cfg.get_configuration_item("jira_adapter")["defaults"]
+        if note.type != "project":
+            console.failure(f"{self.path_note} is not a project")
+            return None
+
+        if not hasattr(note, "us") or not note.us:
+            if note.deliverable == "enhancement":
+                issue_type = {"name": defaults["enhancements"]["issue_type"]}
+                feature = defaults["enhancements"]["feature"]
+                labels = defaults["enhancements"]["labels"].split(",")
+                priority = {"name": defaults["enhancements"]["priority"]}
+            else:
+                issue_type = {"name": defaults["bugs"]["issue_type"]}
+                feature = defaults["bugs"]["feature"]
+                labels = defaults["bugs"]["labels"].split(",")
+                priority = {"name": defaults["bugs"]["priority"]}
+
+            description = "No description provided"
+
+            for section in note._data.sections:
+                title, content = section
+                if title == "## Description":
+                    description = content
+
+            new_issue = self._target.create_issue(
+                title = note.title,
+                description = description,
+                feature = feature,
+                issue_type = issue_type,
+                labels = labels,
+                priority = priority,
+                ticket = note.ticket,
+            )
+            note._data.reference["us"] = new_issue.link
+
+            formatted_content = formatter.format(note.get_data())
+
+            self.path_note.write_bytes(formatted_content.encode("utf-8"))
+            console.success(f"Jira Issue {new_issue.key} created from {self.path_note}")
+        else:
+            console.success("No Jira Issue creation necessary")

src/bim/pyproject.toml

@@ -9,9 +9,10 @@ readme = "README.md"
 python = "^3.12"
 click = "8.1.7"
 # doogat-core = "0.1.2"
-buvis-pybase = {version = "0.1.5a5", source = "test-pypi"}  # doogat-core from test-pypi won't install this
-doogat-core = {version = "0.1.3a26", source = "test-pypi"}
-# doogat-core = {path = "../../../../doogat/doogat-core", develop = true}
+# buvis-pybase = {version = "0.1.5a5", source = "test-pypi"}  # doogat-core from test-pypi won't install this
+buvis-pybase = {path = "../../../buvis-pybase", develop = true}
+# doogat-core = {version = "0.1.3a26", source = "test-pypi"}
+doogat-core = {path = "../../../../doogat/doogat-core", develop = true}
 
 [[tool.poetry.source]]
 name = "test-pypi"