wikinator 0.6.0__tar.gz → 0.6.2__tar.gz

{wikinator-0.6.0/src/wikinator.egg-info → wikinator-0.6.2}/PKG-INFO

@@ -1,13 +1,7 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: wikinator
-Version: 0.6.0
+Version: 0.6.2
 Summary: Convert Google docs to markdown
-Project-URL: Documentation, https://github.com/philion/wikinator#readme
-Project-URL: Issues, https://github.com/philion/wikinator/issues
-Project-URL: Source, https://github.com/philion/wikinator
-Requires-Python: >=3.13
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: dotenv>=0.9.9
 Requires-Dist: google-api-python-client>=2.175.0
 Requires-Dist: google-auth-httplib2>=0.2.0
@@ -16,7 +10,11 @@ Requires-Dist: gql[all]>=3.5.3
 Requires-Dist: pytest>=8.4.1
 Requires-Dist: python-docx>=1.2.0
 Requires-Dist: typer-slim>=0.16.0
-Dynamic: license-file
+Requires-Python: >=3.13
+Project-URL: Documentation, https://github.com/philion/wikinator#readme
+Project-URL: Issues, https://github.com/philion/wikinator/issues
+Project-URL: Source, https://github.com/philion/wikinator
+Description-Content-Type: text/markdown
 
 # wikinator
 
@@ -39,7 +37,7 @@ Usage: wikinator upload [OPTIONS] SOURCE WIKIROOT
 
 Arguments:
   SOURCE    [required]
-  WIKIROOT  [required]
+  WIKIROOT  defaults to root of wiki, /
 
 Options:
   --help  Show this message and exit.
@@ -47,7 +45,6 @@ Options:
 
 Given a directory, convert supported file types into markdown-based files while maintaining names and directory structure. This can then be uploaded into various wiki systems.
 
-Here is a simple footnote[^3].
 
 ### Supported File Types
 - DOCX files (default for GDocs) are converted to markdown
@@ -64,15 +61,30 @@ The development log will be kept here until the 1.0 release.
 
 ## Usage
 ```
-uvx wikinator upload target_dir wikipath
+uvx wikinator upload target_dir
+uvx wikinator upload target_file.md new/path
 ```
 
-`upload` loads a full directory into wiki.js
+`upload` loads a full directory into the wiki. In the above examples:
+- Upload the directoy tree at `target_dir` into the wikipath `target_dir`
+- Upload the file `target_file.md` into the wiki path `new/path/target_file`
+
+Assuming the `en` locale, the final paths in the wiki will be:
+- $GRAPH_DB/en/target_dir/...
+- $GRAPH_DB/en/new/path/target_file
 
 ## Install & Configure
 There is nothing to install, the `wikinator` command can be run from anywhere [`uvx` is installed](https://docs.astral.sh/uv/getting-started/installation/).
 
-To upload to your wiki, you must have credentials.
+To upload to your wiki, you must have the URL and an authorization token.
+
+Create a file in your home directory: `~/.config/wikinator.env`
+
+In that file, add your wiki GraphQL URL and the access token:
+```
+GRAPH_DB=https://wiki.example.org/graphql
+AUTH_TOKEN=your-authorization-token
+```
 
 ### wiki.js
 

{wikinator-0.6.0 → wikinator-0.6.2}/README.md

@@ -19,7 +19,7 @@ Usage: wikinator upload [OPTIONS] SOURCE WIKIROOT
 
 Arguments:
   SOURCE    [required]
-  WIKIROOT  [required]
+  WIKIROOT  defaults to root of wiki, /
 
 Options:
   --help  Show this message and exit.
@@ -27,7 +27,6 @@ Options:
 
 Given a directory, convert supported file types into markdown-based files while maintaining names and directory structure. This can then be uploaded into various wiki systems.
 
-Here is a simple footnote[^3].
 
 ### Supported File Types
 - DOCX files (default for GDocs) are converted to markdown
@@ -44,15 +43,30 @@ The development log will be kept here until the 1.0 release.
 
 ## Usage
 ```
-uvx wikinator upload target_dir wikipath
+uvx wikinator upload target_dir
+uvx wikinator upload target_file.md new/path
 ```
 
-`upload` loads a full directory into wiki.js
+`upload` loads a full directory into the wiki. In the above examples:
+- Upload the directoy tree at `target_dir` into the wikipath `target_dir`
+- Upload the file `target_file.md` into the wiki path `new/path/target_file`
+
+Assuming the `en` locale, the final paths in the wiki will be:
+- $GRAPH_DB/en/target_dir/...
+- $GRAPH_DB/en/new/path/target_file
 
 ## Install & Configure
 There is nothing to install, the `wikinator` command can be run from anywhere [`uvx` is installed](https://docs.astral.sh/uv/getting-started/installation/).
 
-To upload to your wiki, you must have credentials.
+To upload to your wiki, you must have the URL and an authorization token.
+
+Create a file in your home directory: `~/.config/wikinator.env`
+
+In that file, add your wiki GraphQL URL and the access token:
+```
+GRAPH_DB=https://wiki.example.org/graphql
+AUTH_TOKEN=your-authorization-token
+```
 
 ### wiki.js
 

{wikinator-0.6.0 → wikinator-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wikinator"
-version = "0.6.0"
+version = "0.6.2"
 description = "Convert Google docs to markdown"
 readme = "README.md"
 requires-python = ">=3.13"
@@ -35,5 +35,19 @@ tests = ["tests", "*/wikinator/tests"]
 [tool.coverage.report]
 exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
 
+#[tool.hatch]
+
+#[build-system]
+#requires = ["hatchling"]
+#build-backend = "hatchling.build"
+
+#[tool.hatch.build.targets.wheel]
+#packages = ["src/wikinator"]
+
+[build-system]
+requires = ["uv_build>=0.8.10,<0.9.0"]
+build-backend = "uv_build"
+
+
 [project.scripts]
 wikinator = "wikinator:app"

{wikinator-0.6.0 → wikinator-0.6.2}/src/wikinator/__init__.py

@@ -4,6 +4,9 @@ import json
 import typer
 from typing import Optional
 from typing_extensions import Annotated
+import os
+from dotenv import load_dotenv
+
 
 from .wiki import GraphIngester, GraphDB
 
@@ -73,7 +76,9 @@ def trace_callback(value: bool) -> None:
 @app.command()
 def upload(
     source: str,
-    wikiroot: str,
+    wikiroot: str = "/",
+    #url: Annotated[str, typer.Option("--db", help="URL of the GraphQL database")] = os.getenv("GRAPH_DB"),
+    #token: Annotated[str, typer.Option("--token", help="URL of the GraphQL database")] = os.getenv("AUTH_TOKEN"),
     output: Annotated[bool, typer.Option("-o", help="Make a local copy of the converted file")] = False,
 ) -> None:
     """
@@ -86,7 +91,12 @@ def upload(
     For example, with source=/src and wikiroot=/wiki/root,
     a DOCX file at /src/dir/some_file.docx will be uploaded to /wiki/root/dir/some_file on the wiki.
     """
-    GraphIngester(output=output).convert_directory(source, wikiroot)
+    load_dotenv(dotenv_path=os.path.expanduser("~/.config/wikinator.env"))
+    url = os.getenv("GRAPH_DB")
+    token = os.getenv("AUTH_TOKEN")
+    log.debug(f"Loaded env, db={url}")
+
+    GraphIngester(url=url, token=token, output=output).convert_directory(source, wikiroot)
 
 
 # Setup global options using callbacks

{wikinator-0.6.0 → wikinator-0.6.2}/src/wikinator/page.py

@@ -39,16 +39,16 @@ class Page:
     @classmethod
     def load(cls, params: dict[str,any]):
         return cls(
-            id = params["id"],
-            content = params["content"],
-            editor  = params["editor"],
-            isPublished = params["isPublished"],
-            isPrivate = params["isPrivate"],
-            locale = params["locale"],
-            path = params["path"],
-            tags = params["tags"],
-            title = params["title"],
-            description = params["description"],
+            id = params.get("id"),
+            content = params.get("content"),
+            editor  = params.get("editor"),
+            isPublished = params.get("isPublished"),
+            isPrivate = params.get("isPrivate"),
+            locale = params.get("locale"),
+            path = params.get("path"),
+            tags = params.get("tags"),
+            title = params.get("title"),
+            description = params.get("description"),
         )
 
 

{wikinator-0.6.0 → wikinator-0.6.2}/src/wikinator/wiki.py

@@ -17,20 +17,17 @@ log = logging.getLogger(__name__)
 
 
 class GraphDB:
-    def __init__(self):
-        self.client = self._init_client()
+    def __init__(self, url:str, token:str):
+        self.client = self._init_client(url, token)
         self.pageCache = self.all_pages()
 
-    def _init_client(self) -> Client:
+    def _init_client(self, url:str, token:str) -> Client:
         """
         Initialize the GraphQL client with the credentials found in the system ENV:
         - GRAPH_DB : The full URL for requests to the graph DB
         - AUTH_TOKEN : Security token to authorize session
         """
-        load_dotenv()
-        db_url = os.getenv("GRAPH_DB")
-        token = os.getenv("AUTH_TOKEN")
-        transport = AIOHTTPTransport(url=db_url, headers={'Authorization': f'Bearer {token}'}, ssl=True)
+        transport = AIOHTTPTransport(url=url, headers={'Authorization': f'Bearer {token}'}, ssl=True)
         return Client(transport=transport)
 
 
@@ -218,13 +215,16 @@ class GraphDB:
 
 
 class GraphIngester(Converter):
-    def __init__(self, output:bool = False):
-        self.db = GraphDB()
+    def __init__(self, url:str, token:str, output:bool = False):
+        self.db = GraphDB(url, token)
         self.output = output
 
     # use the "file walk" from the converter to upload
     def convert_file(self, full_path:Path, outroot:str):
-        wikipath = f"{outroot}/{full_path.parent}/{full_path.stem}"
+        if outroot.strip() in ["/", ""]:
+            wikipath = f"{full_path.parent}/{full_path.stem}"
+        else:
+            wikipath = f"{outroot}/{full_path.parent}/{full_path.stem}"
         log.info(f"Converting {full_path} into {wikipath}")
 
         page = DocxitConverter.load_file(full_path)

wikinator-0.6.0/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Paul Philion
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

wikinator-0.6.0/PKG-INFO

@@ -1,280 +0,0 @@
-Metadata-Version: 2.4
-Name: wikinator
-Version: 0.6.0
-Summary: Convert Google docs to markdown
-Project-URL: Documentation, https://github.com/philion/wikinator#readme
-Project-URL: Issues, https://github.com/philion/wikinator/issues
-Project-URL: Source, https://github.com/philion/wikinator
-Requires-Python: >=3.13
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: dotenv>=0.9.9
-Requires-Dist: google-api-python-client>=2.175.0
-Requires-Dist: google-auth-httplib2>=0.2.0
-Requires-Dist: google-auth-oauthlib>=1.2.2
-Requires-Dist: gql[all]>=3.5.3
-Requires-Dist: pytest>=8.4.1
-Requires-Dist: python-docx>=1.2.0
-Requires-Dist: typer-slim>=0.16.0
-Dynamic: license-file
-
-# wikinator
-
-Convert a Google drive download into a markdown-based wiki.
-
-**Note**: This is a work in progress, and not all features will be supported or working properly.
-
-## tl;dr
-```
-uvx wikinator upload --help
-Usage: wikinator upload [OPTIONS] SOURCE WIKIROOT
-
-  Convert and upload a file hierarchy to a GraphQL wiki. Given a source
-  directrory, walk the directory tree and for each file: - if MD or image
-  file, upload at the same path relative to the wikiroot path - If DOCX,
-  convert to MD and upload at the same path... - Unknown files are skipped.
-  For example, with source=/src and wikiroot=/wiki/root, A DOCX file at
-  /src/dir/some_file.docx will be uploaded to /wiki/root/dir/some_file on the
-  wiki.
-
-Arguments:
-  SOURCE    [required]
-  WIKIROOT  [required]
-
-Options:
-  --help  Show this message and exit.
-```
-
-Given a directory, convert supported file types into markdown-based files while maintaining names and directory structure. This can then be uploaded into various wiki systems.
-
-Here is a simple footnote[^3].
-
-### Supported File Types
-- DOCX files (default for GDocs) are converted to markdown
-- images are extracted, uploaded and embedded in the markdown
-- FUTURE `text` and code file types are wrapped in markdown code blocks
-- FUTURE CSV and XSLT are converted to markdown tables
-- FUTURE for any document that is converted to markdown, a copy of the original is uploaded and attached
-
-### Supported Wiki Import
-- wiki.js (and other GraphQL-based wikis)
-- Obsidian
-
-The development log will be kept here until the 1.0 release.
-
-## Usage
-```
-uvx wikinator upload target_dir wikipath
-```
-
-`upload` loads a full directory into wiki.js
-
-## Install & Configure
-There is nothing to install, the `wikinator` command can be run from anywhere [`uvx` is installed](https://docs.astral.sh/uv/getting-started/installation/).
-
-To upload to your wiki, you must have credentials.
-
-### wiki.js
-
-TODO: Details on setting up creds for wikijs.
-
-Once you have the URL and authorization token from wiki,js, add them to an `.env` file:
-```
-GRAPH_DB=https://wiki.example.com/graphql
-AUTH_TOKEN=kfhgdkfjhgkdjfhgkdjhfgk...
-```
-
-Once this file is set up correctly, `wikinator` is run with:
-```
-uvx wikinator upload --help
-```
-
-
-## Build & Test
-1. Clone
-    ```
-    git clone https://github.com/philion/wikinator.git
-    cd wikinator
-    ```
-2. Run, with uv
-    ```
-    uv run wikinator [options]
-    ```
-3. Test, with pytest
-    ```
-    uv run pytest
-    ```
-
-## Development Log
-
-### 2025-08-07
-Refactored and disabled (for now) the convert, extract and teleport commands. The code remains in place, but the
-current focus is on convert and upload to graphql, and I wan to disable any code that's not in that path while testing.
-
-Added a verbose logging option, `-v`, to watch files being processed.
-
-### 2025-07-08
-Initial (buggy, probably) implementation of the full command set:
-- `convert` converts directory full of DOCX into markdown.
-- `extract` extracts the docs from google docs as markdown.
-- `upload` loads a full directory into wiki.js
-- `teleport` goes directly from google drive to wiki.js.
-
-### 2025-07-07
-Decent progress with google drive download. Still lots of problems.
-- [ ] get single file and dir params working.
-- [x] fix `\n` translation problem. where are they coming from
-- [ ] for single input file, assume single output filename (if doen't exists). if does, and is dir, write -in-.
-- [x] simple formatting tests
-- [ ] research which converter google is using
-
-pandoc doesn't do embedding the same way (HTML-only): https://pandoc.org/MANUAL.html#option--embed-resources%5B
-
-
-### 2025-07-06
-Getting into formatting details, and I want to decompse and stream-line the docxit converter.
-- [x] docxit creates in memory
-- [x] better page handling, read and write files to disk
-- [x] get first test working
-- [x] simple formatting tests
-- [x] build commands (unimplemented)
-- [ ] for single input file, assume single output filename (if doen't exists). if does, and is dir, write -in-.
-
-Let's combine testing lists with a simple test:
-- load a file with a list
-- convert
-- confirm it contains the correct list
-
-Moved the code around to simplify and remove potential circular dependencies.
-
-Code runs as expected, as does trival test case.
-
-Bumping version to 0.5, but not yet ready to release.
-
-Thinking about commands:
-- convert : files -> files
-- extract : from googledocs -> file system
-- upload  : from files -> graphql
-- teleport : from googledoc -> graphql
-
-Refactored __main__ to better commands. Got `-v` working.
-
-Original behavior is working as `wikinator convert`.
-
-Now looking at extract command.
-
-
-### 2025-07-05
-Starting work on image preservation.
-
-Looking first at https://github.com/haesleinhuepf/docx2markdown for images.
-
-Created a `Docx2MarkdownConverter` which almost works: images are put in the wrong path in the MD (`s/images/` instead of just `images`).
-There's probably an easy fix, but lets try a pandoc version.
-
-Creating `PandocConverter` to try and compare output.
-```
-pandoc {indoc} -f docx -t markdown --wrap=none --markdown-headings=atx --extract-media=images -o {outdoc}
-```
-
-Neither produces desired results.
-
-Trying a literal hack of docx2markdown, to see how quickly I can fix the little problems I saw.
-
-Got it working quickly, removed a little bug, got the images.
-
-Now looking over the DOCX XML format to see how much I can scrape out.
-
-https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.fontsizecomplexscript?view=openxml-3.0.1
-
-Added detection for strikethru and Courier New (as "code font").
-
-This is good enough for v0.2!
-
-Oops. minor bug. fixing with v0.3
-
-Noticed when working on strikethru that nested lists didn't seem to be working.
-
-Next tasks:
-- [x] List handling
-- [x] Code cleanup (remove unused libs)
-- [ ] restructure docxit for in-memory
-- [ ] simple testing.
-- [x] recognize and handle single file
-- [x] default output to local dir
-
-Looking over the raw XML, it looks like...
-```xml
-<w:numPr>
-    <w:ilvl w:val="0" />
-    <w:numId w:val="2" />
-</w:numPr>
-```
-It looks like:
-* `w:ilvl` is the zero-based indent level
-* `w:numId` is an ID from numbering.xml, roughly mapping to:
-    - val=1 ordered list: `1. `
-    - val=2 checklist: `- [ ]`
-    - val=3 bullet: `* `
-
-Restructured and cleaned up. Removed unneeded code and libraried.
-
-Created a simple docx doc for testing.
-
-Far enough that a new release feels right. v0.4!
-
-
-### 2025-07-04
-Let's make a project! Today's goals:
-- [x] clean up code and README
-- [x] add CLI options, using type (not all implemented)
-- [x] initial commit to github
-- [ ] add image handling
-- [x] upload to pypi and confirm uvx commands
-
-Cruft removed. README updated. (author waves, breaking 4th wall)
-
-Moving on the main() cleanup and adding support for https://github.com/fastapi/typer
-
-Added simple CLI options for src and dest. Got end-to-end tree processing.
-
-Added Makefile to help with release management. Got PyPI setup: https://pypi.org/project/wikinator/
-
-`uvx wikinator` is working.
-
-Let's go for git and call it a day!
-
-### 2025-07-03
-Next steps are testing different document converters and accessing google drive via API.
-
-#### Markdown conversion libraries
-- pandoc, see https://docs.asciidoctor.org/asciidoctor/latest/migrate/ms-word/
-- markitdown, https://github.com/microsoft/markitdown
-- docx2markdown, https://github.com/haesleinhuepf/docx2markdown
-- docx2md, https://github.com/mattn/docx2md
-
-Reference:
-- https://www.docstomarkdown.pro/convert-word-or-docs-to-markdown-using-pandoc/
-
-#### Google Drive API
-Starting with https://developers.google.com/workspace/drive/api/quickstart/python
-
-> Note: Follow those Google directions for setting up everything. It's complicated compared to simply generating a service token. Your intrepid author made different tokens in different accounts and couldn't access anything! And get permissions right! Document specific needs in intstall docs.
-
-Further aside: There are two versions of the tool: file-based and google-takeout. The google related stuff will always be a bear to setup.
-
-Made suffienct progress to feel like there a seperate CLI tool here. Set aside for now, and focus on:
-1. Build file-based output
-2. Generate and link images
-3. Clean up for initial 0.1 version
-
-### 2025-07-02
-Initial time-boxed work started to examine what would be required to migrate our existing GoogleDocs-based info repo into a wiki, with wiki.js being targeted.
-
-Initial proof-of-concept goals:
-- Convert a docx page to md or asciidoc
-- Upload test pages to wiki.js
-
-[^3]: At 25-08-10 19:35, Paul Philion said: This is a test comment.
-
-I was able to get this working in sample code in a few hours.

wikinator-0.6.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

wikinator-0.6.0/src/wikinator.egg-info/SOURCES.txt

@@ -1,15 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-src/wikinator/__init__.py
-src/wikinator/converter.py
-src/wikinator/docxit.py
-src/wikinator/gdrive.py
-src/wikinator/page.py
-src/wikinator/wiki.py
-src/wikinator.egg-info/PKG-INFO
-src/wikinator.egg-info/SOURCES.txt
-src/wikinator.egg-info/dependency_links.txt
-src/wikinator.egg-info/entry_points.txt
-src/wikinator.egg-info/requires.txt
-src/wikinator.egg-info/top_level.txt

wikinator-0.6.0/src/wikinator.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

wikinator-0.6.0/src/wikinator.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-wikinator = wikinator:app

wikinator-0.6.0/src/wikinator.egg-info/requires.txt

@@ -1,8 +0,0 @@
-dotenv>=0.9.9
-google-api-python-client>=2.175.0
-google-auth-httplib2>=0.2.0
-google-auth-oauthlib>=1.2.2
-gql[all]>=3.5.3
-pytest>=8.4.1
-python-docx>=1.2.0
-typer-slim>=0.16.0

wikinator-0.6.0/src/wikinator.egg-info/top_level.txt

@@ -1 +0,0 @@
-wikinator