https://github.com/alexriina/anki-sqlalchemy

Python ORM for interacting with Anki's database. Aliases cryptic columns, parses confusing data structures. Designed to be the base of your Anki analysis project.
https://github.com/alexriina/anki-sqlalchemy

anki python sqlalchemy

Last synced: 3 months ago
JSON representation

Python ORM for interacting with Anki's database. Aliases cryptic columns, parses confusing data structures. Designed to be the base of your Anki analysis project.

• Host: GitHub
• URL: https://github.com/alexriina/anki-sqlalchemy
• Owner: AlexRiina
• License: mit
• Archived: true
• Created: 2020-07-07T23:41:57.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-01T20:25:48.000Z (over 3 years ago)
• Last Synced: 2024-09-25T21:03:01.258Z (3 months ago)
• Topics: anki, python, sqlalchemy
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PyPi Version](https://img.shields.io/pypi/v/anki_sqlalchemy.svg)](https://pypi.python.org/pypi/anki_sqlalchemy/)

Anki SQLAlchemy is an interface for interacting with the

[Anki](https://apps.ankiweb.net/) sqlite database from python without having to

either hack an Anki install or figure out the database structure and field

serialization from scratch.

The goal of this project is not to support every version of Anki entirely. The

current version supports at a signficant amount of the Anki 2.1.38.

Here is a small code snippet written first without `anki_sqlalchemy` to show

how unintuivite the data format and columns names are without an wrapper.

```python

# plain python without anki-sqlalchemy

import sqlite3

conn = sqlite3.connect('backup.db')

cursor = conn.execute("SELECT id, tags FROM notes WHERE mod >= ?", [1445394366])

note = cursor.fetchone()

note[0]  # 1428143940996

note[1]  # ' edit math probability wikipedia '

cursor = conn.execute("SELECT mod, type FROM cards WHERE nid = ?", [nid])

card = cursor.fetchone()

card[0]  # 1445394366

card[1]  # 2

```

```python

# with anki-sqlalchemy

import datetime

from sqlalchemy import create_engine

from sqlalchemy.orm import sessionmaker

from anki_sqlalchemy import Card

engine = create_engine("sqlite:///backup.db", echo=True)

Session = sessionmaker(bind=engine)

session = Session()

note = session.query(Note).filter(Note.modification_time >= datetime.datetime(2017, 2, 5, 21, 29, 49)).first()

note.id  # 1428143940996

note.modification_time  # datetime.datetime(2017, 2, 5, 21, 29, 49)

card = note.cards[0]

card.modification_time  # datetime.datetime(2019, 11, 5, 22, 23, 3)

card.type  # 

```

Anki SQLAlchemy also plays nicely with types too.

```python

card: Card = session.query(Card).first()

reveal_type(card.modification_time)

# Revealed type is 'datetime.datetime*'

reveal_type(card.note.tags)

# Revealed type is 'builtins.list*[builtins.str]'

```

# BEWARE!

This package can be used to make changes to your anki database. Before

proceeding, please make a backup of your database file. You don't want to lose

all your work with a bad query.

The Anki database typically lives in a `collection.anki2` file.

# Install

```

pip install anki_sqlalchemy

```