AnkiAPI

https://pypi.org/project/ankiapi/
Admin
A simple Python wrapper for interacting with the AnkiConnect API to create and manage Anki...
Tokens:2,160
Snippets:54
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Installation with pip

Source: https://pypi.org/project/ankiapi

Install the ankiapi package using pip.

```bash
pip install ankiapi
```

--------------------------------

### Basic Example

Source: https://pypi.org/project/ankiapi/0.2.1

Initialize the AnkiApi and add a new deck and flashcard.

```python
from ankiapi import AnkiApi

# Initialize the API (make sure Anki is running with AnkiConnect add-on)
anki = AnkiApi()

# Create a new deck
anki.create_deck("Python Programming")

# Add a flashcard
anki.add_flashcard(
    deck_name="Python Programming",
    front="What is a Python list comprehension?",
    back="A concise way to create lists using a single line of code with a for loop and optional conditions."
)
```

--------------------------------

### Installation with Poetry

Source: https://pypi.org/project/ankiapi/0.2.1

Add the ankiapi package to your project using Poetry.

```bash
poetry add ankiapi
```

--------------------------------

### Installation with pip

Source: https://pypi.org/project/ankiapi/0.2.1

Install the ankiapi package using pip.

```bash
pip install ankiapi==0.2.1
```

--------------------------------

### AnkiApi Class Initialization

Source: https://pypi.org/project/ankiapi/0.2.1

Initialize the AnkiApi class with optional URL and version parameters.

```python
AnkiApi(url="http://localhost:8765", version=6)
```

--------------------------------

### Adding Audio to Anki

Source: https://pypi.org/project/ankiapi/0.2.1

Add an audio file to Anki using the add_audio method.

```python
# Add an audio file
anki.add_audio(
    path="/path/to/audio/file.mp3",
    filename="pronunciation.mp3"
)
```

--------------------------------

### File Hashes for ankiapi-0.2.1.tar.gz

Source: https://pypi.org/project/ankiapi/0.2.1

Hashes for the source distribution file.

```text
Algorithm | Hash digest |
---|---|---
SHA256 |  `b12e8e926d394aa17a1daa441ba206a1b976ca295b98ba5ec0af22d40aa71d89` |
MD5 |  `e60eab388adabca2f24866af651b6846` |
BLAKE2b-256 |  `bf5336115225b6ac71217ade6e1b949354020ac697a3dd133a7ebb0c170d0460` |
```

--------------------------------

### File Hashes for ankiapi-0.2.1-py3-none-any.whl

Source: https://pypi.org/project/ankiapi/0.2.1

Hashes for the wheel distribution file.

```text
Algorithm | Hash digest |
---|---|---
SHA256 |  `47179439f904de6358493712a6ebd4bcb22894dd49c35e318d67eace8bd3e110` |
MD5 |  `805c60437373f5fd483b61d30c2534e3` |
BLAKE2b-256 |  `83901695275093aa2ffe0ab401ae5a17c610ef6a9dbc968844ca02f321eba4d2` |
```

--------------------------------

### Wheel File Name Format

Source: https://pypi.org/project/ankiapi/0.2.1

Information about the format of wheel file names.

```text
ankiapi-0.2.1-py3-none-any.whl
```
Tokens:
Raw