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).
Features
- Extract item metadata from a Zotero auto‑exported BibTeX file
- Pull PDF annotations directly from the Zotero
zotero.sqlitedatabase - 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vscotero-0.3.0.tar.gz.
File metadata
- Download URL: vscotero-0.3.0.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c989d8e5d6655162ef1dde61f0bae81cda139d6c784330faa0af9faafe1d4729
|
|
| MD5 |
754d2b94440c76dfc61d80c1157bea94
|
|
| BLAKE2b-256 |
88dbbbf7a249dad8cf867b0d7a026d5b9bdcb6cce3d33c8466eab061a33f29d9
|
File details
Details for the file vscotero-0.3.0-py3-none-any.whl.
File metadata
- Download URL: vscotero-0.3.0-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6807ac69b6eefc2de830b3197a6f5297167b4665d2c9aac5c42f9755dc589742
|
|
| MD5 |
628934dcd80c154cdbf096b302d32313
|
|
| BLAKE2b-256 |
e779f682acaf8f1d37aa9091d62fd3eb7a175d592362b03ede1988d4825b23cc
|