anki-reader

Name	anki-reader JSON
Version	0.0.1 JSON
	download
home_page	None
Summary	A package for reading Anki database.
upload_time	2024-08-25 01:33:56
maintainer	None
docs_url	None
author	None
requires_python	>=3.10
license	MIT
keywords	one two
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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  🔧

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "anki-reader",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "one, two",
    "author": null,
    "author_email": "Tony <cordial.egg1739@fastmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e1/eb/a464314c88137d667a23b197d0a8bac7ee07834a9093f34890ee90adc7ea/anki_reader-0.0.1.tar.gz",
    "platform": null,
    "description": "# Anki db reader\nA simple package for reading from anki database.\n\n# Quickstart\n\n## Installation \ud83d\udee0\ufe0f\n\nFrom PyPI\nanki_reader is available on PyPI. To install with `pip`, just run\n\n```\npip install anki_reader\n```\n\n##  Setup \ud83d\udd28\n\nReview the `.env.example` file for the required environment variables\n\n## Usage - Commands/Features\n\nThis covers the main use cases for the library.\n\n```python\n# create anki object\nanki = AnkiDB()\n\n# get user reviews - a premade query (returns df)\nreviews = anki.get_user_reviews()\nprint(reviews)\n\n# get . from database - any query you write (returns df)\ncards = anki.query_db(\"select * from cards limit 5\")\nprint(cards)\n\n```\n\n# Development  \ud83d\udd27\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A package for reading Anki database.",
    "version": "0.0.1",
    "project_urls": null,
    "split_keywords": [
        "one",
        " two"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e017374bdb16ee6b1a717da9155e6952d88e527f560e151a8dbc6de7ea41ff2",
                "md5": "6cacd3345c9c6de5611e0e328dd98e42",
                "sha256": "0c8954a09eea35df7931bd0a03e8ed531241160aed1cfcb61036556599ead9ac"
            },
            "downloads": -1,
            "filename": "anki_reader-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6cacd3345c9c6de5611e0e328dd98e42",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 4219,
            "upload_time": "2024-08-25T01:33:55",
            "upload_time_iso_8601": "2024-08-25T01:33:55.348310Z",
            "url": "https://files.pythonhosted.org/packages/6e/01/7374bdb16ee6b1a717da9155e6952d88e527f560e151a8dbc6de7ea41ff2/anki_reader-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e1eba464314c88137d667a23b197d0a8bac7ee07834a9093f34890ee90adc7ea",
                "md5": "149aa4f76b155b01467290202d5fe28e",
                "sha256": "4098d13c3ef378b91359090b0823ed3704d0bf8b42408eb2f47ae78bbedcec4d"
            },
            "downloads": -1,
            "filename": "anki_reader-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "149aa4f76b155b01467290202d5fe28e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 5217,
            "upload_time": "2024-08-25T01:33:56",
            "upload_time_iso_8601": "2024-08-25T01:33:56.192121Z",
            "url": "https://files.pythonhosted.org/packages/e1/eb/a464314c88137d667a23b197d0a8bac7ee07834a9093f34890ee90adc7ea/anki_reader-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-25 01:33:56",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "anki-reader"
}