Skip to main content

VSCode + Zotero literature note ingester

Project description

vscotero

Generate markdown literature notes from your Zotero library (metadata + annotations) for use in VS Code (Foam / wiki links compatible).

demonstration of vscotero usage

Features

  • Extract item metadata from a Zotero auto‑exported BibTeX file
  • Pull PDF annotations directly from the Zotero zotero.sqlite database
  • Group annotations by highlight color (configurable colormap)

Recommended installation: pip

pip install vscotero

Then configure Zotero to auto-export a BibTeX file (Better BibTeX recommended) and create a config.toml file (see example below).

Example config.toml

[notes]
bib_path = "/absolute/path/to/library.bib"   # Zotero auto-export (Better BibTeX)
md_path  = "/absolute/path/to/notes"         # Output folder for generated notes
db_path  = "~/Zotero/zotero.sqlite"           # Zotero database path

Usage

Ingest all notes:

vscotero ingest --path config.toml

Color Map

Override in config.toml (any subset):

[notes.colormap]
"#ffd400" = "Insights"
"#ff6666" = "Discrepancies"

See CHANGELOG.md for release notes.

Build from source

git clone https://github.com/katnykiel/vscotero
cd vscotero
python -m venv .venv
source .venv/bin/activate
pip install -e .

TODOs

  • fix the config system
    • add CLI option, put config.toml in some default path
    • remove .bib path? doesn't db have this info
  • confirmation prompt before deletion
  • check if it overwrites notes (it does, fix)
  • add color hex codes to default config.toml with description
  • error handling
  • better tests for edge cases / bad config
  • add a nix install

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

vscotero-0.2.2.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vscotero-0.2.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file vscotero-0.2.2.tar.gz.

File metadata

  • Download URL: vscotero-0.2.2.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vscotero-0.2.2.tar.gz
Algorithm Hash digest
SHA256 dfec7347c6261c08c14bca36cd6854791cdfac52a29a8b9a7457f088138540ef
MD5 ab7b33fcd16ac3af3c287949a74409fa
BLAKE2b-256 610999f758a9f0cb6fa7eca17cb161816a4ce184e993dfc9ea93c0bb3b5112cb

See more details on using hashes here.

File details

Details for the file vscotero-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: vscotero-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vscotero-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8f4f99607d4c824187c57e950c60e3f39509b227728bb3dc2425cc4938be8442
MD5 cbc1752b3efa9c431b663f68a7a5a7d6
BLAKE2b-256 de9a72c77de3eed58863386dc1f5a469c281b65a34f8ca4edd25e834df2b2b3c

See more details on using hashes here.

Supported by

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