https://github.com/centrefordigitalhumanities/lidia-browser

Fetch and display LIDIA annotations from the Zotero group library
https://github.com/centrefordigitalhumanities/lidia-browser

Last synced: 10 days ago
JSON representation

Fetch and display LIDIA annotations from the Zotero group library

• Host: GitHub
• URL: https://github.com/centrefordigitalhumanities/lidia-browser
• Owner: CentreForDigitalHumanities
• License: bsd-3-clause
• Created: 2023-09-27T13:32:36.000Z (about 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-04-03T15:25:14.000Z (8 months ago)
• Last Synced: 2024-04-24T11:12:07.151Z (7 months ago)
• Language: Python
• Size: 104 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# LIDIA Browser: Linguistic Diagnostics explorer

This is the source code for the [LIDIA Annotation Browser](https://lidia.hum.uu.nl/) website.

The annotation browser is a companion to the [LIDIA Zotero plugin](https://github.com/CentreForDigitalHumanities/lidia-zotero) for LIDIA, a pilot project for annotating linguistic diagnostics.

It is a Django project containing two apps:

- The `sync` app contains management commands and logic for fetching publication and annotation data from a Zotero library via the Zotero API using [pyzotero](https://github.com/urschrei/pyzotero).

- The `lidia` app contains functions for converting LIDIA YAML annotations to Django structures, and provides a browse/search interface using the Django Admin.

## Installation

Install the dependencies:

    pip install -r requirements.txt

Create a file `.env` in the repository root with your Zotero library and authentication details.

See the [pyzotero quickstart](https://github.com/urschrei/pyzotero#quickstart) for where to get a Zotero API key and find your library ID.

```sh

ZOTERO_LIBRARY_ID=12345

# Library type is 'user' or 'group'

ZOTERO_LIBRARY_TYPE=group

ZOTERO_API_KEY=a1b2c3d

```

By default, LIDIA Browser is set to use SQLite3, so no database setup is necessary.

## Usage

To run on a local machine, use:

```sh

cd lidiabrowser

python manage.py migrate

python manage.py sync

python manage.py populate

python manage.py runserver

```

You can remove raw sync data or converted sync data from the database using the `--refresh` option:

```sh

python manage.py sync --refresh

python manage.py populate --refresh

```