https://github.com/okomestudio/orgutils

The PKM helper for Emacs Org mode written in Python.
https://github.com/okomestudio/orgutils

data-export data-transformation emacs org-mode pkm python

Last synced: about 1 month ago
JSON representation

The PKM helper for Emacs Org mode written in Python.

• Host: GitHub
• URL: https://github.com/okomestudio/orgutils
• Owner: okomestudio
• License: mit
• Created: 2023-07-11T23:45:43.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2025-09-25T08:12:03.000Z (8 months ago)
• Last Synced: 2025-10-30T14:52:00.339Z (7 months ago)
• Topics: data-export, data-transformation, emacs, org-mode, pkm, python
• Language: Python
• Homepage:
• Size: 70.3 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
********************

orgutils

********************

The PKM helper for Emacs Org mode written in Python.

This tool currently supports Org-format conversion of notes/annotations/highlights dumps

from several PKM services and devices.

Annotation Exports in Org format

================================

Kindle

------

To convert an export JSON dump from Kindle notes and highlights using `Bookcision

`_ to an Org file, use ``org-from-kindle``.

.. code-block:: shell

   org-from-kindle -h                 # help

   org-from-kindle -l en   # dump is in English

   org-from-kindle -l ja   # dump is in Japanese

Snipd

-----

To convert an export Markdown dump from `Snipd `_ to an Org file,

use ``org-from-snipd``.

.. code-block:: shell

   org-from-snipd -h                    # help

   org-from-snipd        # Org export of Snipd dump

   org-from-snipd    # extract -th section

Zotero

------

To export a PDF document from a local `Zotero `_ installation to

an Org file, use ``org-from-zotero``.

.. code-block:: shell

   org-from-zotero -h            # help

   org-from-zotero list          # get doc IDs

   org-from-zotero extract   # Org export of doc with ID

Installation

============

The ``orgutils`` is a pure Python package. As such, it is best to install it to a clean

virtual environment. We assume the following install commands are run within such an

environment.

.. code-block:: shell

   pip install .

   pip install .[dev,test]  # for local development

The Snipd submodule uses `pandoc `_. Install it

separately if you need it.