Metadata-Version: 2.1
Name: anki_reader
Version: 0.0.1
Summary: A package for reading Anki database.
Author-email: Tony <cordial.egg1739@fastmail.com>
License: MIT
Keywords: one,two
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: python-dotenv
Requires-Dist: importlib-metadata; python_version < "3.10"
Provides-Extra: dev
Requires-Dist: py-teamup[release,static-code-qa,test]; extra == "dev"
Provides-Extra: release
Requires-Dist: build; extra == "release"
Requires-Dist: twine; extra == "release"
Provides-Extra: static-code-qa
Requires-Dist: pre-commit; extra == "static-code-qa"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"

# Anki db reader
A simple package for reading from anki database.

# Quickstart

## Installation 🛠️

From PyPI
anki_reader is available on PyPI. To install with `pip`, just run

```
pip install anki_reader
```

##  Setup 🔨

Review the `.env.example` file for the required environment variables

## Usage - Commands/Features

This covers the main use cases for the library.

```python
# create anki object
anki = AnkiDB()

# get user reviews - a premade query (returns df)
reviews = anki.get_user_reviews()
print(reviews)

# get . from database - any query you write (returns df)
cards = anki.query_db("select * from cards limit 5")
print(cards)

```

# Development  🔧
