Skip to main content

This project is deprecated. Please see ankisync2.

ankisync

PyPI version shields.io PyPI license

Doing what AnkiConnect cannot do, including

  • Creating new *.apkg
  • Creating new note type / model
  • Upserting notes
  • Setting next review
  • Setting card statistics
  • Note ids to Card ids

But of course, this is very unsafe compared to pure AnkiConnect. I will not hold liability to damage it may cost.

Usage

Please close your Anki application first before doing this!

from ankisync.anki import Anki
with Anki() as a:
    a.add_model(
        name='foo',
        fields=['field_a', 'field_b', 'field_c'],
        templates={
            'Forward': (QUESTION1, ANSWER1),
            'Reverse': (QUESTION2, ANSWER2)
        }
    )

Most of the other API's are similar to AnkiConnect, but _by_id()'s are preferred.

Creating a new *.apkg is also possible.

from ankisync.apkg import Apkg
with Apkg('bar.apkg') as a:
    model_id = a.init(
        first_model=dict(
            name='foo',
            fields=['field_a', 'field_b', 'field_c'],
            templates={
                'Forward': (QUESTION1, ANSWER1),
                'Reverse': (QUESTION2, ANSWER2)
            }
        ),
        first_deck='baz',
        first_note_data=False
    )
    a.add_note({
        'modelName': 'foo',
        'deckId': 1,  # "Default" deck
        'fields': {
            'field_a': 'aaaaa',
            'field_b': 123  # Numbers will be converted to string.
        }
    })

For the example of how I use it in action, see https://github.com/patarapolw/zhlib/blob/master/zhlib/export.py

Installation

pip install ankisync

Contributions

  • What features outside AnkiConnect (or inside) do you want? I will try to implement it.
  • Help me understand the documentations, AnkiDroid Wiki, and Anki decks collaboration Wiki
  • Please help me implement the NotImplemented methods.

Note

  • This is the successor to AnkiTools. I will not update it anymore.

Release files for ankisync 0.2.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ankisync 0.2.3.1
File Size Uploaded
ankisync-0.2.3.1.tar.gz 20.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ankisync 0.2.3.1
File Interpreter ABI Platform
ankisync-0.2.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 44.9 kB

Release files / ankisync-0.2.3.1.tar.gz

Download URL ankisync-0.2.3.1.tar.gz
Size 20.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ac7df24c5c4c4a82cdf4caf883c2efc4868b6ccccdcc3485eb4fa830d816a270
BLAKE2b-256 checksum
How to use checksums
7bb5da9ced5a03ddb43a41c1fb790f8aff89e357f7666a98bf097926bb1c343a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.4 CPython/3.7.0 Linux/5.4.0-53-generic

Release files / ankisync-0.2.3.1-py3-none-any.whl

Download URL ankisync-0.2.3.1-py3-none-any.whl
Size 24.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e3f767d9f5df221b25e8bc7204f7dd16a6417142319bad59cabe7895674383ca
BLAKE2b-256 checksum
How to use checksums
40053fc25c23456cc24a92e690114d898947fb5ae426af1e82524166a871fc07
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.4 CPython/3.7.0 Linux/5.4.0-53-generic

Release history Release notifications | RSS feed

This release

0.2.3.1 This release

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page