Skip to main content

A small asynchronous wrapper for the FicHub API, made to retrieve story metadata and download stories from various websites.

Project description

FicHub API Wrapper

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-wrapper currently requires Python 3.8 or higher.

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

# Linux/macOS
python3 -m pip install -U git+https://github.com/Sachaa-Thanasius/fichub-api-wrapper

# Windows
py -3 -m pip install -U git+https://github.com/Sachaa-Thanasius/fichub-api-wrapper

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())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fichub_api-0.2.2.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

fichub_api-0.2.2-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file fichub_api-0.2.2.tar.gz.

File metadata

  • Download URL: fichub_api-0.2.2.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for fichub_api-0.2.2.tar.gz
Algorithm Hash digest
SHA256 ca9f3f583ddea86e265cb0df5aa31a628ed63b0aff14f2415c2325f3ba921319
MD5 039b52d5a7b51178144cc30320ba1959
BLAKE2b-256 3c96227519b0459ad1116a4498d4ddd69257ca5c5935b065ff70ccc3c71ac4e0

See more details on using hashes here.

File details

Details for the file fichub_api-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: fichub_api-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for fichub_api-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e27c80f5e7d7310ec561f3340c8a3be1ca81f0130960a033f29b70ac9d865f35
MD5 732b580f56819670295f593eaee18245
BLAKE2b-256 abbca968c97da0c60a7a61f4a48a02d0e33c6681d2e494f3a615507d71f4c714

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page