Skip to content

Sachaa-Thanasius/fichub-api

Repository files navigation

FicHub API Wrapper

PyPI supported Python versions License: MIT Checked with pyright Ruff Code style: black

A small asynchronous wrapper for the FicHub API, made to retrieve story data from various fanfiction and original fiction sites. For more information about FicHub, see their website and git repos.

Installing

fichub-api currently requires Python 3.8 or higher.

To install the library, run one of the following commands:

# Linux/macOS
python3 -m pip install -U fichub-api

# Windows
py -3 -m pip install -U fichub-api

Example

For more examples, see the examples folder.

import asyncio
import aiohttp
import fichub_api as fichub

async def main():
    async with aiohttp.ClientSession() as session:
        client = fichub.Client(session=session)
        url = "https://www.fanfiction.net/s/13912800/1/Magical-Marvel"
        story_metadata = await client.get_story_metadata(url)
        print(
            f"Story Metadata (link: '{story_metadata.url}')\n",
            f"    {story_metadata.title}\n",
            f"        {story_metadata.description}\n"
        )

asyncio.run(main())

About

A simple asynchronous wrapper for the FicHub API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages