notekey 0.1.0__tar.gz → 0.1.2__tar.gz

{notekey-0.1.0 → notekey-0.1.2}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: notekey
-Version: 0.1.0
+Version: 0.1.2
 Summary: CLI utilities for Obsidian vault notes: initialize note bases, search markdown files, and read note content.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+Requires-Dist: black>=26.3.1
 Requires-Dist: python-frontmatter>=1.1.0
 Requires-Dist: readtime>=3.0.0
 
@@ -38,7 +39,9 @@ notekey search [path] [--tags TAGS] [--filename NAME] [--content TEXT]
 notekey read FILENAME
 ```
 
-If `path` is omitted, `notekey` uses the `OBSIDIAN_VAULT` environment variable. If that variable is not set, it uses the current directory.
+For `init`, omitting `path` uses the current directory.
+
+For `search` and `read`, omitting `path` uses the `OBSIDIAN_VAULT` environment variable. If that variable is not set, it uses the current directory.
 
 ```bash
 export OBSIDIAN_VAULT="/path/to/your/vault"
@@ -46,6 +49,13 @@ export OBSIDIAN_VAULT="/path/to/your/vault"
 
 ### Initialize a note folder
 
+```bash
+cd /path/to/vault/Projects/MyProject
+notekey init
+```
+
+Or pass the target folder explicitly:
+
 ```bash
 notekey init /path/to/vault/Projects/MyProject
 ```

{notekey-0.1.0 → notekey-0.1.2}/README.md

@@ -29,7 +29,9 @@ notekey search [path] [--tags TAGS] [--filename NAME] [--content TEXT]
 notekey read FILENAME
 ```
 
-If `path` is omitted, `notekey` uses the `OBSIDIAN_VAULT` environment variable. If that variable is not set, it uses the current directory.
+For `init`, omitting `path` uses the current directory.
+
+For `search` and `read`, omitting `path` uses the `OBSIDIAN_VAULT` environment variable. If that variable is not set, it uses the current directory.
 
 ```bash
 export OBSIDIAN_VAULT="/path/to/your/vault"
@@ -37,6 +39,13 @@ export OBSIDIAN_VAULT="/path/to/your/vault"
 
 ### Initialize a note folder
 
+```bash
+cd /path/to/vault/Projects/MyProject
+notekey init
+```
+
+Or pass the target folder explicitly:
+
 ```bash
 notekey init /path/to/vault/Projects/MyProject
 ```

{notekey-0.1.0 → notekey-0.1.2}/notekey/main.py

@@ -45,12 +45,16 @@ def _build_filters(name: str, tags: str | None = None) -> str:
     return ", ".join(f'"{tag}"' for tag in filters)
 
 
-def _create_base(target: Path, name: str, tags: str | None = None, force: bool = False) -> Path:
+def _create_base(
+    target: Path, name: str, tags: str | None = None, force: bool = False
+) -> Path:
     vault_root = _find_vault_root(target)
     folder = target.relative_to(vault_root).as_posix()
     filters = _build_filters(name, tags)
     base_path = target / f"{name}.base"
-    content = BASE_FILTER_TEMPLATE.format(folder=folder, name=name, filters=filters).lstrip()
+    content = BASE_FILTER_TEMPLATE.format(
+        folder=folder, name=name, filters=filters
+    ).lstrip()
 
     if base_path.exists() and not force:
         raise FileExistsError(f"Base file already exists: {base_path}")
@@ -124,9 +128,7 @@ def _search_files(
     filename_exact, filename_val = (
         _parse_filter(filename) if filename else (False, None)
     )
-    content_exact, content_val = (
-        _parse_filter(content) if content else (False, None)
-    )
+    content_exact, content_val = _parse_filter(content) if content else (False, None)
     parsed_tags: list[tuple[bool, str]] = (
         [_parse_filter(t) for t in tags] if tags else []
     )
@@ -199,11 +201,7 @@ def _display_search_results(results: list[Markdown], vault_root: Path) -> None:
 
     for md in results:
         rel = _relative_to_vault(md, vault_root)
-        tags_str = (
-            ", ".join(md.tags[:5])
-            + ("..." if len(md.tags) > 5 else "")
-            or "—"
-        )
+        tags_str = ", ".join(md.tags[:5]) + ("..." if len(md.tags) > 5 else "") or "—"
         print(
             f"  {rel:<{name_width}}  "
             f"tags: [{tags_str}]  "
@@ -236,7 +234,7 @@ def build_parser() -> argparse.ArgumentParser:
         "path",
         nargs="?",
         default=None,
-        help="Target folder (defaults to $OBSIDIAN_VAULT or current directory)",
+        help="Target folder (defaults to current directory)",
     )
     init_parser.add_argument(
         "-t",
@@ -250,7 +248,9 @@ def build_parser() -> argparse.ArgumentParser:
     )
 
     # -- search -------------------------------------------------------------
-    search_parser = subparsers.add_parser("search", help="Search markdown files in the vault")
+    search_parser = subparsers.add_parser(
+        "search", help="Search markdown files in the vault"
+    )
     search_parser.add_argument(
         "path",
         nargs="?",
@@ -274,7 +274,9 @@ def build_parser() -> argparse.ArgumentParser:
     )
 
     # -- read ---------------------------------------------------------------
-    read_parser = subparsers.add_parser("read", help="Read a single markdown file by name or path")
+    read_parser = subparsers.add_parser(
+        "read", help="Read a single markdown file by name or path"
+    )
     read_parser.add_argument(
         "filename",
         help="Filename or path to match — first match wins (prefix = for exact)",
@@ -288,7 +290,7 @@ def main() -> None:
     args = parser.parse_args()
 
     if args.command == "init":
-        target = _get_folder(_resolve_path(args.path))
+        target = _get_folder(args.path)
         current_location = str(target)
         folder_name = target.name
         base_path = _create_base(target, folder_name, tags=args.tags, force=args.force)

{notekey-0.1.0 → notekey-0.1.2}/notekey/markdown.py

@@ -5,7 +5,12 @@ from typing import Any
 import frontmatter
 import readtime
 
-from notekey.utils import extract_inline_tags, extract_markdown_links, extract_wiki_links, normalize_size
+from notekey.utils import (
+    extract_inline_tags,
+    extract_markdown_links,
+    extract_wiki_links,
+    normalize_size,
+)
 
 
 class Markdown:
@@ -37,7 +42,8 @@ class Markdown:
         self.name = self._path.stem
         self._size_bytes: float = float(stat.st_size)
         self.size = self._size_bytes
-        self.created_at = datetime.datetime.fromtimestamp(stat.st_birthtime)
+        created_ts = getattr(stat, "st_birthtime", stat.st_ctime)
+        self.created_at = datetime.datetime.fromtimestamp(created_ts)
         self.updated_at = datetime.datetime.fromtimestamp(stat.st_mtime)
 
         # Full raw content (frontmatter + body) — needed for link extraction.
@@ -83,6 +89,4 @@ class Markdown:
         return normalize_size(self._size_bytes)
 
     def __repr__(self) -> str:
-        return (
-            f"<Markdown filename='{self.name}' size='{self._normalize_size()}'>"
-        )
+        return f"<Markdown filename='{self.name}' size='{self._normalize_size()}'>"

{notekey-0.1.0 → notekey-0.1.2}/notekey/template.py

@@ -1,4 +1,4 @@
-BASE_FILTER_TEMPLATE="""
+BASE_FILTER_TEMPLATE = """
 views:
   - type: table
     name: Notes
@@ -22,7 +22,7 @@ views:
         direction: ASC
 """
 
-MOC_TEMPLATE="""
+MOC_TEMPLATE = """
 ### Notes
 ![[{name}.base]]
 """

{notekey-0.1.0 → notekey-0.1.2}/notekey/utils.py

@@ -20,9 +20,7 @@ def extract_inline_tags(text: str) -> set[str]:
     # Match #identifier (with optional /path).  The tag body cannot
     # contain a trailing period so that ``#tag.`` correctly yields ``tag``.
     pattern = re.compile(
-        r"(?:^|(?<=\s))"
-        r"#([a-zA-Z_][a-zA-Z0-9_/-]*)"
-        r"(?=\s|$|[.,;:!?)])"
+        r"(?:^|(?<=\s))" r"#([a-zA-Z_][a-zA-Z0-9_/-]*)" r"(?=\s|$|[.,;:!?)])"
     )
 
     for match in pattern.finditer(body):

{notekey-0.1.0 → notekey-0.1.2}/notekey.egg-info/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: notekey
-Version: 0.1.0
+Version: 0.1.2
 Summary: CLI utilities for Obsidian vault notes: initialize note bases, search markdown files, and read note content.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+Requires-Dist: black>=26.3.1
 Requires-Dist: python-frontmatter>=1.1.0
 Requires-Dist: readtime>=3.0.0
 
@@ -38,7 +39,9 @@ notekey search [path] [--tags TAGS] [--filename NAME] [--content TEXT]
 notekey read FILENAME
 ```
 
-If `path` is omitted, `notekey` uses the `OBSIDIAN_VAULT` environment variable. If that variable is not set, it uses the current directory.
+For `init`, omitting `path` uses the current directory.
+
+For `search` and `read`, omitting `path` uses the `OBSIDIAN_VAULT` environment variable. If that variable is not set, it uses the current directory.
 
 ```bash
 export OBSIDIAN_VAULT="/path/to/your/vault"
@@ -46,6 +49,13 @@ export OBSIDIAN_VAULT="/path/to/your/vault"
 
 ### Initialize a note folder
 
+```bash
+cd /path/to/vault/Projects/MyProject
+notekey init
+```
+
+Or pass the target folder explicitly:
+
 ```bash
 notekey init /path/to/vault/Projects/MyProject
 ```

{notekey-0.1.0 → notekey-0.1.2}/notekey.egg-info/requires.txt

@@ -1,2 +1,3 @@
+black>=26.3.1
 python-frontmatter>=1.1.0
 readtime>=3.0.0

{notekey-0.1.0 → notekey-0.1.2}/pyproject.toml

@@ -4,11 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "notekey"
-version = "0.1.0"
+version = "0.1.2"
 description = "CLI utilities for Obsidian vault notes: initialize note bases, search markdown files, and read note content."
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
+    "black>=26.3.1",
     "python-frontmatter>=1.1.0",
     "readtime>=3.0.0",
 ]

{notekey-0.1.0 → notekey-0.1.2}/tests/test_main.py

@@ -25,7 +25,6 @@ from notekey.main import (
     main,
 )
 
-
 # ---------------------------------------------------------------------------
 #  Fixtures: a mini vault with several .md files
 # ---------------------------------------------------------------------------
@@ -39,8 +38,7 @@ def vault(tmp_path: Path) -> Path:
     (root / ".obsidian").mkdir()
 
     # File A: has tags "python" and "web", mentions "flask"
-    (root / "flask-app.md").write_text(
-        """\
+    (root / "flask-app.md").write_text("""\
 ---
 title: Flask App
 tags: [python, web]
@@ -48,12 +46,10 @@ tags: [python, web]
 # Flask App
 
 Building a web app with #flask.
-"""
-    )
+""")
 
     # File B: has tags "python" and "data", mentions "pandas"
-    (root / "pandas-guide.md").write_text(
-        """\
+    (root / "pandas-guide.md").write_text("""\
 ---
 title: Pandas Guide
 tags: [python, data]
@@ -61,12 +57,10 @@ tags: [python, data]
 # Pandas Guide
 
 Working with #pandas and dataframes.
-"""
-    )
+""")
 
     # File C: has tags "javascript" and "web", mentions "react"
-    (root / "react-setup.md").write_text(
-        """\
+    (root / "react-setup.md").write_text("""\
 ---
 title: React Setup
 tags: [javascript, web]
@@ -74,30 +68,25 @@ tags: [javascript, web]
 # React Setup
 
 Getting started with #react.
-"""
-    )
+""")
 
     # File D: no frontmatter tags, but has inline #tag, no frontmatter
-    (root / "scratchpad.md").write_text(
-        """\
+    (root / "scratchpad.md").write_text("""\
 # Scratchpad
 
 Random thoughts and #ideas.
-"""
-    )
+""")
 
     # File E: in subdirectory
     sub = root / "deep"
     sub.mkdir()
-    (sub / "hidden-note.md").write_text(
-        """\
+    (sub / "hidden-note.md").write_text("""\
 ---
 title: Hidden
 tags: [python, devops]
 ---
 Hidden note about #docker and #kubernetes.
-"""
-    )
+""")
 
     return root
 
@@ -115,7 +104,9 @@ class TestPathAndVaultHelpers:
         monkeypatch.setenv("OBSIDIAN_VAULT", "/env/vault")
         assert _resolve_path() == "/env/vault"
 
-    def test_resolve_path_default_current_dir(self, monkeypatch: pytest.MonkeyPatch) -> None:
+    def test_resolve_path_default_current_dir(
+        self, monkeypatch: pytest.MonkeyPatch
+    ) -> None:
         monkeypatch.delenv("OBSIDIAN_VAULT", raising=False)
         assert _resolve_path() == "."
 
@@ -206,7 +197,9 @@ class TestFilenameAndRelativePathHelpers:
             "deep/hidden-note",
         )
 
-    def test_filename_candidates_outside_vault(self, tmp_path: Path, vault: Path) -> None:
+    def test_filename_candidates_outside_vault(
+        self, tmp_path: Path, vault: Path
+    ) -> None:
         note = tmp_path / "outside.md"
         note.write_text("outside")
         assert _filename_candidates(note, vault) == ("outside", "outside.md", "outside")
@@ -252,7 +245,13 @@ class TestSearchFiles:
         results = _search_files(vault)
         # 5 .md files across the vault (4 in root + 1 in deep/)
         names = {md.name for md in results}
-        assert names == {"flask-app", "pandas-guide", "react-setup", "scratchpad", "hidden-note"}
+        assert names == {
+            "flask-app",
+            "pandas-guide",
+            "react-setup",
+            "scratchpad",
+            "hidden-note",
+        }
         assert len(results) == 5
 
     def test_filename_filter(self, vault: Path) -> None:
@@ -489,9 +488,7 @@ class TestDisplayFile:
         assert "Building a web app with #flask." in captured.out
         assert "---" in captured.out
 
-    def test_no_extra_output(
-        self, vault: Path, capsys: pytest.CaptureFixture
-    ) -> None:
+    def test_no_extra_output(self, vault: Path, capsys: pytest.CaptureFixture) -> None:
         from notekey.markdown import Markdown
 
         raw = (vault / "flask-app.md").read_text()
@@ -509,7 +506,10 @@ class TestDisplayFile:
 
 class TestMainCommandBranches:
     def test_main_init(
-        self, vault: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+        self,
+        vault: Path,
+        monkeypatch: pytest.MonkeyPatch,
+        capsys: pytest.CaptureFixture,
     ) -> None:
         target = vault / "new-project"
         target.mkdir()
@@ -522,8 +522,33 @@ class TestMainCommandBranches:
         assert (target / "new-project.base").exists()
         assert (target / "new-project.md").exists()
 
+    def test_main_init_without_path_uses_current_directory(
+        self,
+        vault: Path,
+        monkeypatch: pytest.MonkeyPatch,
+        capsys: pytest.CaptureFixture,
+    ) -> None:
+        target = vault / "01-PROJECTS" / "OpenClaw"
+        target.mkdir(parents=True)
+        monkeypatch.setenv("OBSIDIAN_VAULT", str(vault))
+        monkeypatch.chdir(target)
+        monkeypatch.setattr(sys, "argv", ["notekey", "init", "--force"])
+
+        main()
+
+        captured = capsys.readouterr()
+        assert f"Created base: {target / 'OpenClaw.base'}" in captured.out
+        assert f"Created markdown: {target / 'OpenClaw.md'}" in captured.out
+        assert (target / "OpenClaw.base").exists()
+        assert (target / "OpenClaw.md").exists()
+        assert not (vault / "vault.base").exists()
+        assert not (vault / "vault.md").exists()
+
     def test_main_search_uses_obsidian_vault_default(
-        self, vault: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+        self,
+        vault: Path,
+        monkeypatch: pytest.MonkeyPatch,
+        capsys: pytest.CaptureFixture,
     ) -> None:
         monkeypatch.setenv("OBSIDIAN_VAULT", str(vault))
         monkeypatch.setattr(sys, "argv", ["notekey", "search", "--tags", "python"])
@@ -535,7 +560,10 @@ class TestMainCommandBranches:
         assert "flask-app.md" in captured.out
 
     def test_main_read_no_results(
-        self, vault: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+        self,
+        vault: Path,
+        monkeypatch: pytest.MonkeyPatch,
+        capsys: pytest.CaptureFixture,
     ) -> None:
         monkeypatch.setenv("OBSIDIAN_VAULT", str(vault))
         monkeypatch.setattr(sys, "argv", ["notekey", "read", "missing-note"])
@@ -546,7 +574,10 @@ class TestMainCommandBranches:
         assert "No file found matching: missing-note" in captured.out
 
     def test_main_read_single_result(
-        self, vault: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+        self,
+        vault: Path,
+        monkeypatch: pytest.MonkeyPatch,
+        capsys: pytest.CaptureFixture,
     ) -> None:
         monkeypatch.setenv("OBSIDIAN_VAULT", str(vault))
         monkeypatch.setattr(sys, "argv", ["notekey", "read", "=flask-app"])
@@ -557,7 +588,10 @@ class TestMainCommandBranches:
         assert captured.out == (vault / "flask-app.md").read_text()
 
     def test_main_read_multiple_results(
-        self, vault: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+        self,
+        vault: Path,
+        monkeypatch: pytest.MonkeyPatch,
+        capsys: pytest.CaptureFixture,
     ) -> None:
         monkeypatch.setenv("OBSIDIAN_VAULT", str(vault))
         monkeypatch.setattr(sys, "argv", ["notekey", "read", "a"])
@@ -568,12 +602,17 @@ class TestMainCommandBranches:
         assert "Multiple matches" in captured.out
 
     def test_script_entrypoint(
-        self, vault: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+        self,
+        vault: Path,
+        monkeypatch: pytest.MonkeyPatch,
+        capsys: pytest.CaptureFixture,
     ) -> None:
         monkeypatch.setenv("OBSIDIAN_VAULT", str(vault))
         monkeypatch.setattr(sys, "argv", ["notekey", "read", "=flask-app"])
 
-        runpy.run_path(str(Path(__file__).parents[1] / "notekey" / "main.py"), run_name="__main__")
+        runpy.run_path(
+            str(Path(__file__).parents[1] / "notekey" / "main.py"), run_name="__main__"
+        )
 
         captured = capsys.readouterr()
         assert captured.out == (vault / "flask-app.md").read_text()
@@ -600,7 +639,16 @@ class TestBuildParser:
     def test_search_accepts_all_flags(self) -> None:
         parser = build_parser()
         args = parser.parse_args(
-            ["search", "/some/path", "--tags", "a,b", "--filename", "test", "--content", "hello"]
+            [
+                "search",
+                "/some/path",
+                "--tags",
+                "a,b",
+                "--filename",
+                "test",
+                "--content",
+                "hello",
+            ]
         )
         assert args.path == "/some/path"
         assert args.tags == "a,b"

{notekey-0.1.0 → notekey-0.1.2}/tests/test_markdown.py

@@ -6,7 +6,12 @@ from pathlib import Path
 import pytest
 
 from notekey.markdown import Markdown
-from notekey.utils import extract_inline_tags, extract_markdown_links, extract_wiki_links, normalize_size
+from notekey.utils import (
+    extract_inline_tags,
+    extract_markdown_links,
+    extract_wiki_links,
+    normalize_size,
+)
 
 # ---------------------------------------------------------------------------
 #  Fixtures
@@ -236,9 +241,7 @@ class TestMarkdownInit:
 
 
 class TestMarkdownTags:
-    def test_tags_combined_from_frontmatter_and_inline(
-        self, sample_md: Path
-    ) -> None:
+    def test_tags_combined_from_frontmatter_and_inline(self, sample_md: Path) -> None:
         md = Markdown(sample_md)
         # frontmatter: project, documentation, obsidian
         # inline: python, testing, project/active, topic/obsidian/plugins
@@ -309,9 +312,7 @@ class TestMarkdownMetadata:
         assert md.metadata["created"] == datetime.date(2024, 1, 15)
         assert md.metadata["status"] == "active"
 
-    def test_no_frontmatter_metadata(
-        self, sample_md_no_frontmatter: Path
-    ) -> None:
+    def test_no_frontmatter_metadata(self, sample_md_no_frontmatter: Path) -> None:
         md = Markdown(sample_md_no_frontmatter)
         assert md.metadata == {}