/Zettelkasten-notion-reader

This is a utility written in Python that reads a Zettelkasten database in Notion to create an Obsidian like Graph View (WIP)

Primary LanguagePython

Notion Zettelkasten Reader

Introduction

This is a Notion reader for my Zettelkasten database. It will give me an Obsidian like graph view of my Zettels

Note this is for personal uses but you can adapt it to your goals

Installation

Use Poetry and then do poetry install

Roadmap

  • Reading data from Zettelkasten's database
  • Add support for rudimentary caching
  • Creating a first graph of the database
  • Creating an interactive graph, using visualization tools for Machine Learning
    • Adding the possibility to filter them
  • Document the code and all of its functions
  • Add pytest tests
  • Use a pluggable pattern, maybe something like pluggy to add plugins to this reader

Dependencies

  • Typer: CLI stuff
  • Pydantic: Validation of settings
  • Requests: HTTP requests

License

MIT License

Copyright (c) 2022 Asdrúbal Suárez

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.