Metadata-Version: 2.1
Name: zotnote
Version: 0.1.0
Summary: Streamlining reading notes with Zotero
Home-page: https://github.com/bubblbu/zotnote
License: MIT
Keywords: zotero,literature-review,reading-notes
Author: Asura Enkhbayar
Author-email: asura.enkhbayar@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: click (>=7.1.1,<8.0.0)
Requires-Dist: jinja2 (>=2.11.1,<3.0.0)
Requires-Dist: python-dotenv (>=0.12.0,<0.13.0)
Requires-Dist: tomlkit (>=0.5.11,<0.6.0)
Requires-Dist: xdg (>=4.0.1,<5.0.0)
Project-URL: Repository, https://github.com/bubblbu/zotnote
Description-Content-Type: text/markdown

# ZotNote

A helper tool that automatises reading note management with Zotero.

## Features

- Connects to local Zotero and Better Bibtex databases to retrieve metadata
- Supports custom templates for reading notes
- CLI interface to populate templates and create reading note skeletons

*Planned features*

- Basic annotations
- Retrieval of tags/keywords from Zotero
- Text analysis of reading notes
- Export as annotated bibliography

## Getting started

### Requirements

I have currently only used the script on my own Linux machine.

- Python 3.6 (I am currently using f-strings)
- [Zotero Standalone](https://www.zotero.org/)
- [Better Bibtex plugin](https://github.com/retorquere/zotero-better-bibtex)

### Installation

Just copy the script found in `src` to a folder on your machine. Make sure to add the folder to your PATH and make the file executable.

## Usage

### Configuration

The script contains a few variables that you have to rename to according to your own file system.

```bash
NOTES = "/path/to/reading/notes"
ZOTERO = "/path/to/zotero"

AUTHOR = "Your Name"
```

Make sure to copy `templates/template.txt` to your NOTES folder.

## Creating your own notes

`new_zotnote.py citekey` should be all you need to start creating your notes. The script will retrieve all required metadata from Zotero and populate the template stored in your notes folder and create a new reading note.
