Skip to main content

Import Zotero annotations with Dendron integration

Project description

Zendron

Version: 1.0.23

Introduction

  • This package was developed for porting Zotero annotations and metadata to markdown. These markdown notes are then brought into a Dendron hierarchy for integration with vault notes. We recommend using the package within Visual Studio Code.The end goal is to get a two way sync between notes in Zotero and notes in Dendron, but this has some difficulties and limitations that are taking some time to address. For now only a one way sync from Zotero to Dendron is supported.

Install Instructions

  • It is recommended to build a conda env for installation.
  • Install Dendron CLI.
    • npm install -g @dendronhq/dendron-cli@latest
  • Install the zendron
    • python -m pip install zendron

Zotero and File Import Configuration

All zendron configuration is handled in config.yml.

library_id : 4932032 # Zotero library ID
library_type : group # [user, group] library
api_key : FoCauOvWMlNdYmpYuY5JplTw # Zotero API key
collection: null # Name of Zotero Collection, null for entire library
item_types: [journalArticle, book, preprint, conferencePaper, report] # List of item types according to [pyzotero](https://pyzotero.readthedocs.io/en/latest/)
local_image_path: /Users/<username>/Zotero/cache # Local path for importing annotated images
dendron_limb: zendron.import # Dendron import limb e.g. zendron.import.paper-title.annotations.md
zotero_comment_title: zendron comment # fixed for now... needed for eventual 2-way sync.
pod_path: zotero_pod # Name of dendron pod, removed

Basic Usage

There are only two basic commands that work as of now.

  • zendron
    • This command imports notes according to a defined config.yml. Once the command is run the first time the user needs to modify there configuration ./conf/config.yaml according the zotero library they want to import.
    • Notes are imported with a ## Time Created heading. This allows for stable reference from other notes, within the note vault. We autogenerate a *.comments.md that should be used for taking any additional notes within Dendron. Addition notes taken within the meta data file (notes/zendron.import.<paper-title>.md), or the *.annotations.md will be overwritten after running zendron for a second time.
  • zendron remove=true
    • This command removes all imported notes and associated links. We run a createMissingLinkedNotes following the deletion of Dendron notes to repopulate tags and users that will be removed on running zendron-remove.
    • There are more complicated removal's that could be desired so we plan to eventually change this from a bool to str.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zendron-1.0.23.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

zendron-1.0.23-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file zendron-1.0.23.tar.gz.

File metadata

  • Download URL: zendron-1.0.23.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for zendron-1.0.23.tar.gz
Algorithm Hash digest
SHA256 301074daa888e189141cd988692cff2d69d0c7548ee58ae09081444247367b53
MD5 e615f411fce1702a437dbbe489e03aaa
BLAKE2b-256 71e23b607ee4e1a4f404ade5e95404efee36879ab55e237335691679ea3d9f9d

See more details on using hashes here.

File details

Details for the file zendron-1.0.23-py3-none-any.whl.

File metadata

  • Download URL: zendron-1.0.23-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for zendron-1.0.23-py3-none-any.whl
Algorithm Hash digest
SHA256 38d9e0f74a615c541740f6fdffb213feafab46af5fb5d8059e4c8cc1aab0f269
MD5 d299ad81d72b4b4a86c2beae593b5e0a
BLAKE2b-256 628164c8ef5d05b8a3591b8fd7e106d86c65fa37b6a3b5e871ae8be7a55fb8a6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page