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/)
