joppylib 0.1.0a12__tar.gz

joppylib-0.1.0a12/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+#dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

joppylib-0.1.0a12/.python-version

@@ -0,0 +1 @@
+3.12

joppylib-0.1.0a12/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com),
+and this project adheres to [Semantic Versioning](https://semver.org).
+
+## [Unreleased]
+
+## [0.1.0a12] - 2026-04-01
+
+### Added
+- Runtime `__version__` attribute derived from package metadata.
+- CHANGELOG.md following Keep a Changelog format.
+- PyPI metadata: license, keywords, classifiers, URLS.
+
+## [0.1.0a11] - 2026-03-31
+
+Alpha development phase, consolidated from releases 0.1.0a1 through 0.1.0a11.
+
+### Added
+- Note management: create, read, update, delete, search, and list notes.
+- Tag management: full CRUD, add/remove tags from notes, get all tags for a note.
+- Folder management: full CRUD operations.
+- Support for events, resources, and revisions.
+- Full-text search using Joplin's search syntax with field filtering and ordering.
+- Batch listing with optional field filtering and ordering parameters.
+- Flexible authentication: interactive (browser-based) and API key-based.
+- Debug mode for including raw API responses.
+- Custom exceptions and connection validation.

joppylib-0.1.0a12/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jeroen Kroesen
+
+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.

joppylib-0.1.0a12/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: joppylib
+Version: 0.1.0a12
+Summary: A thin abstraction layer over the Joplin Data API
+Project-URL: Homepage, https://github.com/jeroenkroesen/joppylib
+Project-URL: Repository, https://github.com/jeroenkroesen/joppylib
+Author-email: Jeroen Kroesen <jeroen@kroesen.nu>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: joplin,joplin-api,notes
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Requires-Dist: pydantic-settings>=2.10.1
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: requests>=2.32.4
+Description-Content-Type: text/markdown
+
+# JopPyLib
+Python abstraction over the Joplin data api  
+  
+==WARNING==  
+JopPyLib is under heavy development. I've only just started. I will update this readme when a first usable version is released.
+
+JopPyLib is part of the [Artumis project](https://jeroenkroesen.github.io/artumis_site/). It is meant to be a thin layer to enable programmatic manipulation of Joplin notes via a higher level interface than the data API.  
+  
+JopPyLib is highly opinionated because it is designed to enable a higher level library call [JopBrainLib](https://github.com/jeroenkroesen/jopbrainlib) that enables second brain functionality in Joplin.  
+  
+An [example Jupyter notebook interface](https://github.com/jeroenkroesen/joppylib-notebook) is available for interacting with JopPyLib.  
+***  
+  
+## Status
+Current release: joppylib-0.1.0a11
+Very alpha testing release.
+***  
+  
+  
+## Roadmap
+- [x] Clean up and document old personal codebase
+- [ ] Complete api layer (`api_client.py`)
+    - [x] Generate packages on github to allow pip install when testing.
+    - [x] Implement PUT
+    - [x] Implement better tag functions
+        - [x] Delete tag from note
+        - [x] Get all tags attached to a note
+    - [ ] Test API functionality
+    - [x] Demonstrate low-level interface in [notebook](https://github.com/jeroenkroesen/joppylib-notebook)
+- [x] Design higher level interface
+- [x] Implement higher level interface  
+
+***
+  
+  
+## Reference
+[Joplin Data API documentation](https://joplinapp.org/help/api/references/rest_api/)

joppylib-0.1.0a12/README.md

@@ -0,0 +1,37 @@
+# JopPyLib
+Python abstraction over the Joplin data api  
+  
+==WARNING==  
+JopPyLib is under heavy development. I've only just started. I will update this readme when a first usable version is released.
+
+JopPyLib is part of the [Artumis project](https://jeroenkroesen.github.io/artumis_site/). It is meant to be a thin layer to enable programmatic manipulation of Joplin notes via a higher level interface than the data API.  
+  
+JopPyLib is highly opinionated because it is designed to enable a higher level library call [JopBrainLib](https://github.com/jeroenkroesen/jopbrainlib) that enables second brain functionality in Joplin.  
+  
+An [example Jupyter notebook interface](https://github.com/jeroenkroesen/joppylib-notebook) is available for interacting with JopPyLib.  
+***  
+  
+## Status
+Current release: joppylib-0.1.0a11
+Very alpha testing release.
+***  
+  
+  
+## Roadmap
+- [x] Clean up and document old personal codebase
+- [ ] Complete api layer (`api_client.py`)
+    - [x] Generate packages on github to allow pip install when testing.
+    - [x] Implement PUT
+    - [x] Implement better tag functions
+        - [x] Delete tag from note
+        - [x] Get all tags attached to a note
+    - [ ] Test API functionality
+    - [x] Demonstrate low-level interface in [notebook](https://github.com/jeroenkroesen/joppylib-notebook)
+- [x] Design higher level interface
+- [x] Implement higher level interface  
+
+***
+  
+  
+## Reference
+[Joplin Data API documentation](https://joplinapp.org/help/api/references/rest_api/)

joppylib-0.1.0a12/docs/dev/improvements_report_2026-03.md

@@ -0,0 +1,149 @@
+# JopPyLib — Critical Examination Report
+**Date:** 2026-03-24
+**Scope:** All source code in `src/joppylib/`
+**Context:** All API traffic targets the Joplin Data API running on the user's localhost. Joplin Server is out-of-scope.
+
+---
+
+## 1. Input Sanitization
+
+### ~~No input sanitization on `query` in `search()` — Correctness bug~~ RESOLVED
+~~`api_client.py:107` interpolates the query directly into the URL string:~~
+```python
+params = f'?query={query}'
+```
+~~A query containing `&`, `=`, `#`, `+`, or spaces will break the URL or inject additional parameters. For example, searching for `C++` results in Joplin receiving `C  ` (plus decoded as space), and searching for `foo&limit=1` would override the pagination limit.~~
+
+**Fixed:** `search()` now uses a `params` dict passed to `requests.get()`, which handles URL encoding automatically. Verified end-to-end against a live Joplin instance with `C++`, `C#`, `foo&bar`, and `key=value` queries.
+
+---
+
+## 2. Bugs & Correctness Issues
+
+### ~~Copy-paste docstring errors~~ RESOLVED
+~~- `delete()` docstring says "Get an entity instance by ID" (`api_client.py:385`, `joplin_client.py:246`).~~
+~~- `update()` docstring says "data for the object to create" (`api_client.py:359`, `joplin_client.py:221`).~~
+
+**Fixed:** Corrected `delete()` docstrings to say "Delete an entity instance by ID" and `update()` parameter descriptions to say "data for the object to update" in both `api_client.py` and `joplin_client.py`.
+
+### ~~`check_connection` ignores non-200 responses (`connection.py:30-33`)~~ RESOLVED
+```python
+try:
+    requests.get(url_ping)
+    return True
+except requests.exceptions.ConnectionError:
+    return False
+```
+~~Any HTTP response (including 500) returns `True`. Only a connection failure returns `False`. A Joplin instance that is up but malfunctioning would be reported as connected.~~
+
+**Fixed:** `check_connection` now uses `resp.ok` (True only for 2xx) and catches the broad `RequestException` base class.
+
+### ~~Inconsistent return types across methods~~ ACCEPTED (by design)
+- `get()`, `create()`, `update()`, `delete()` return raw `requests.Response`.
+- `search()`, `get_multi()`, `get_all_tags()` return `Dict[str, Any]` with a `success`/`data`/`error` wrapper.
+
+~~Consumers must handle two completely different response patterns depending on which method they call.~~
+
+**Accepted:** The split maps to a real architectural difference — single-request methods return the raw Response (full access to status, headers, body), while paginated methods aggregate multiple responses into a Dict wrapper. Unifying would either lose information (Response direction) or add unnecessary wrapping (Dict direction). Downstream consumer JopBrainLib already handles both patterns. Type hints document the contract per method.
+
+### ~~`name` class attribute collision in `joplin_client`~~ RESOLVED
+~~`joplin_client.Note` has class attribute `name: str = 'note'`, but its inherited `__init__` takes `name` as a parameter and overwrites it via `self.name = name`. The class attribute is dead code. Same for `Tag`.~~
+
+**Fixed:** Removed dead `name` class attributes from `Note` and `Tag` in `joplin_client.py`. Also corrected `Tag` docstring from "Interact with items" to "Interact with tags".
+
+### ~~Unused `ITEM_TYPE` constant~~ RESOLVED
+~~`defaults.py` defines `ITEM_TYPE = 'note'` but it is never referenced anywhere in the codebase.~~
+
+**Fixed:** Removed `ITEM_TYPE = 'note'` from `defaults.py`.
+
+### Mutable default class attributes (`api_client.py:28-29`)
+```python
+fields: List[str] = []
+fields_create_required: List[str] = []
+```
+Class-level mutable defaults. Not currently mutated, but a latent footgun if any code ever appends to them on an instance.
+
+---
+
+## 3. Robustness Issues
+
+### ~~Auth polling loop has no timeout and no delay (`connection.py:77-81`)~~ RESOLVED
+~~Two problems:~~
+1. ~~If the user never responds to the Joplin auth dialog, this loops forever.~~
+2. ~~There is no `time.sleep()` between polls — it hammers the local Joplin API as fast as Python can loop, which can make the Joplin UI sluggish.~~
+
+**Fixed:** Auth polling now has a configurable timeout and a delay between polls.
+
+### `get_auth_token` doesn't handle HTTP errors (`connection.py:73-74`)
+```python
+resp_init = requests.post(url_init)
+init_token = resp_init.json()['auth_token']
+```
+If the POST returns a non-200 or non-JSON response, this crashes with an unhelpful `KeyError` or `JSONDecodeError`.
+
+### ~~No timeout on any HTTP request~~ RESOLVED
+~~Every `requests.get/post/put/delete` call has no `timeout` parameter. If Joplin freezes (not uncommon for an Electron app under load), the calling Python code hangs indefinitely.~~
+
+**Fixed:** All HTTP requests now have a configurable timeout.
+
+### No retry on paginated operations
+If page 3 of 5 fails, the entire operation fails and all data (including successfully fetched pages 1-2) is discarded.
+
+---
+
+## 4. Design Issues
+
+### ~~Pagination loop duplicated 3 times~~ RESOLVED
+~~The same ~20-line pagination pattern is copy-pasted in `search()` (lines 131-157), `get_multi()` (lines 230-256), and `Note.get_all_tags()` (lines 513-539). They differ only in the initial URL. This has already caused bugs historically (per commits "Fixed: reponse indexes" and "Fixed: added req_index to fix indexing").~~
+
+**Fixed:** Extracted a shared `_paginate()` method on `Item`. All three callers now delegate to it. Also migrated `get_multi()` and `get_all_tags()` from string interpolation to `params=` dict.
+
+### The high-level layer is mostly boilerplate
+Every method in `joplin_client.Item` is a pass-through that prepends `self._api_key` and `self.settings`. ~270 lines exist to hide two parameters. A `requests.Session`-style approach, `functools.partial`, or `__getattr__` delegation could achieve the same in a fraction of the code.
+
+### No connection reuse or shared client instance
+Every API call opens a new TCP connection. There is no shared client instance for connection reuse, central timeout config, or auth handling.
+
+**Recommendation:** Migrate from `requests` to `httpx`. The `httpx.Client` (sync) provides connection pooling, base URL support, and shared config out of the box. Additionally, `httpx.AsyncClient` offers an almost identical async API, enabling a future async interface without a library swap. This is low priority — the library targets localhost so the performance impact is minimal — but it removes a design issue and opens the door for async support.
+
+### `create()` accepts `Dict | str` but `str` bypasses validation (`api_client.py:331-338`)
+When `data` is a string, required field validation is skipped entirely. The user gets a raw HTTP error with no library-level context if it fails.
+
+### `JoplinClient` hard-codes entity specialization (`joplin_client.py:405-410`)
+`folder`, `event`, `resource`, and `revision` use the base `Item` class. This means `resource` can't handle file uploads (per the TODO at `api_client.py:729`), and there's no way for a consumer to know this without reading the source.
+
+### `id` shadows the Python builtin
+Used as a parameter name throughout both layers. Convention is `item_id` or `id_`.
+
+---
+
+## 5. Testing & Quality
+
+### ~~Zero tests~~ RESOLVED
+~~This is the single biggest risk. The git history shows multiple pagination and indexing bugs that were caught manually. The triplicated pagination loop is especially prone to regressions.~~
+
+**Fixed:** 52 tests added across all modules (`test_config.py`, `test_connection.py`, `test_api_client.py`, `test_joplin_client.py`) using `pytest` and `responses` for HTTP mocking. Covers CRUD operations, pagination, auth flows, validation, and delegation.
+
+### No CI/CD pipeline
+No GitHub Actions, no linting, no type checking configured. The `py.typed` marker exists but `mypy`/`pyright` is not configured to run.
+
+### `dist/` directory is checked into git
+11 versions of wheels and tarballs bloat the repository. These should be built and published via CI or GitHub Releases.
+
+---
+
+## Summary
+
+| Priority | Issue | Why it matters |
+|----------|-------|----------------|
+| ~~**High**~~ | ~~No request timeouts~~ | ~~Hangs if Joplin freezes~~ **RESOLVED** |
+| ~~**High**~~ | ~~Auth polling: no timeout, no delay~~ | ~~Infinite loop, pegs CPU, makes Joplin sluggish~~ **RESOLVED** |
+| ~~**High**~~ | ~~URL query not encoded~~ | ~~Searches with special characters break silently~~ **RESOLVED** |
+| ~~**High**~~ | ~~No tests~~ | ~~Every change risks regressions (proven by history)~~ **RESOLVED** |
+| ~~**Medium**~~ | ~~Pagination loop duplicated 3x~~ | ~~Already caused bugs; will again~~ **RESOLVED** |
+| ~~**Medium**~~ | ~~Inconsistent return types (Response vs Dict)~~ | ~~Confusing API for consumers~~ **ACCEPTED (by design)** |
+| ~~**Low**~~ | ~~No shared client / consider httpx migration~~ | ~~No connection reuse; httpx would also enable future async support~~ **ACCEPTED (deferred)** |
+| ~~**Medium**~~ | ~~`check_connection` ignores status codes~~ | ~~False positives~~ **RESOLVED** |
+| ~~**Low**~~ | ~~Copy-paste docstring errors~~ | ~~Misleading docs~~ **RESOLVED** |
+| ~~**Low**~~ | ~~`dist/` in git~~ | ~~Repository bloat~~ **ACCEPTED (deferred)** |
+| ~~**Low**~~ | ~~Unused `ITEM_TYPE`, dead `name` class attrs~~ | ~~Dead code~~ **RESOLVED** |