azaka


Nameazaka JSON
Version 0.4.1 PyPI version JSON
download
home_page
SummaryA work in progress API Wrapper around The Visual Novel Database (VNDB) written in Python.
upload_time2023-07-05 12:46:33
maintainer
docs_urlNone
authormooncell07
requires_python>=3.10,<4.0
licenseMIT
keywords vndb apiwrapper async visualnovel python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            


<p align="center"> <img src="https://cdn-icons-png.flaticon.com/512/2322/2322246.png" height=100> </p>

<p align="center"> we are back!! </p>
<p align="center">
<img alt="Stargazers" src="https://img.shields.io/github/stars/mooncell07/Azaka?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41">
<img alt="Issues" src="https://img.shields.io/github/issues/mooncell07/Azaka?style=for-the-badge&logo=gitbook&color=B5E8E0&logoColor=D9E0EE&labelColor=302D41">
<img alt="Releases" src="https://img.shields.io/github/license/mooncell07/Azaka?style=for-the-badge&logo=github&color=F2CDCD&logoColor=D9E0EE&labelColor=302D41"/>



</p>

# LINKS

- [WELCOME!](#welcome)
  - [FEATURES](#features)
  - [INSTALLATION](#installation)
  - [USAGE](#usage)
  - [DOCUMENTATION & TUTORIAL](#documentation--tutorial)
  - [THANKS](#thanks)

# WELCOME!

Welcome to Azaka, a work-in-progress asynchronous and thin API Wrapper around the [visual novel database](https://vndb.org/) written in python.


## FEATURES

- **Fully Asynchronous** - The library supports Async. communication and other jobs.
- **Clean and Expressive** - Azaka's syntax is 
really clean and expressive with SQL like querying.
- **Well Typehinted & Tested** - Everything in the library is properly typehinted and checked with strict mypy type checking strategy. However there are few exceptions ;)

## INSTALLATION

You can install Azaka using pip.

*soon*

## USAGE

*Example of getting some basic VN data.*

```py
import asyncio
from azaka import Client, Node, select

query = (
    select("title", "image.url")
    .frm("vn")
    .where(Node("id") == "v17")
)

async def main() -> None:
    async with Client() as client:
        resp = await client.execute(query=query)
        vn = resp.results[0]
        print(vn.id, vn.title, vn.image["url"], sep="\n")

asyncio.run(main())
```

## DOCUMENTATION & TUTORIAL

Documentation will be available soon.


## THANKS

Thank you for your visit :)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "azaka",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "vndb,apiwrapper,async,visualnovel,python",
    "author": "mooncell07",
    "author_email": "mooncell07@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/01/eb/31f94a80f2a58013cc7d7e9f535b4926a48c2da42b19317bb6569da7fe1f/azaka-0.4.1.tar.gz",
    "platform": null,
    "description": "\n\n\n<p align=\"center\"> <img src=\"https://cdn-icons-png.flaticon.com/512/2322/2322246.png\" height=100> </p>\n\n<p align=\"center\"> we are back!! </p>\n<p align=\"center\">\n<img alt=\"Stargazers\" src=\"https://img.shields.io/github/stars/mooncell07/Azaka?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41\">\n<img alt=\"Issues\" src=\"https://img.shields.io/github/issues/mooncell07/Azaka?style=for-the-badge&logo=gitbook&color=B5E8E0&logoColor=D9E0EE&labelColor=302D41\">\n<img alt=\"Releases\" src=\"https://img.shields.io/github/license/mooncell07/Azaka?style=for-the-badge&logo=github&color=F2CDCD&logoColor=D9E0EE&labelColor=302D41\"/>\n\n\n\n</p>\n\n# LINKS\n\n- [WELCOME!](#welcome)\n  - [FEATURES](#features)\n  - [INSTALLATION](#installation)\n  - [USAGE](#usage)\n  - [DOCUMENTATION & TUTORIAL](#documentation--tutorial)\n  - [THANKS](#thanks)\n\n# WELCOME!\n\nWelcome to Azaka, a work-in-progress asynchronous and thin API Wrapper around the [visual novel database](https://vndb.org/) written in python.\n\n\n## FEATURES\n\n- **Fully Asynchronous** - The library supports Async. communication and other jobs.\n- **Clean and Expressive** - Azaka's syntax is \nreally clean and expressive with SQL like querying.\n- **Well Typehinted & Tested** - Everything in the library is properly typehinted and checked with strict mypy type checking strategy. However there are few exceptions ;)\n\n## INSTALLATION\n\nYou can install Azaka using pip.\n\n*soon*\n\n## USAGE\n\n*Example of getting some basic VN data.*\n\n```py\nimport asyncio\nfrom azaka import Client, Node, select\n\nquery = (\n    select(\"title\", \"image.url\")\n    .frm(\"vn\")\n    .where(Node(\"id\") == \"v17\")\n)\n\nasync def main() -> None:\n    async with Client() as client:\n        resp = await client.execute(query=query)\n        vn = resp.results[0]\n        print(vn.id, vn.title, vn.image[\"url\"], sep=\"\\n\")\n\nasyncio.run(main())\n```\n\n## DOCUMENTATION & TUTORIAL\n\nDocumentation will be available soon.\n\n\n## THANKS\n\nThank you for your visit :)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A work in progress API Wrapper around The Visual Novel Database (VNDB) written in Python.",
    "version": "0.4.1",
    "project_urls": null,
    "split_keywords": [
        "vndb",
        "apiwrapper",
        "async",
        "visualnovel",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bef62183426d646f136272d56fc812808ed66ebc90c8c85abe62a2140dd92f15",
                "md5": "7bba3f0a269d18e54f312b76c02a80b2",
                "sha256": "519b68eadca1ebd9c4137ebf54c0be1f6c2e260abb81583379576344956c3bc7"
            },
            "downloads": -1,
            "filename": "azaka-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7bba3f0a269d18e54f312b76c02a80b2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 8004,
            "upload_time": "2023-07-05T12:46:31",
            "upload_time_iso_8601": "2023-07-05T12:46:31.628889Z",
            "url": "https://files.pythonhosted.org/packages/be/f6/2183426d646f136272d56fc812808ed66ebc90c8c85abe62a2140dd92f15/azaka-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "01eb31f94a80f2a58013cc7d7e9f535b4926a48c2da42b19317bb6569da7fe1f",
                "md5": "534136d70344505204f8b2ad960d793a",
                "sha256": "61dd73e126a0340b4fceb746e6fc91634670d41ac3adc958e5eaf80df17028fa"
            },
            "downloads": -1,
            "filename": "azaka-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "534136d70344505204f8b2ad960d793a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 6258,
            "upload_time": "2023-07-05T12:46:33",
            "upload_time_iso_8601": "2023-07-05T12:46:33.327086Z",
            "url": "https://files.pythonhosted.org/packages/01/eb/31f94a80f2a58013cc7d7e9f535b4926a48c2da42b19317bb6569da7fe1f/azaka-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-05 12:46:33",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "azaka"
}
        
Elapsed time: 0.11521s