Metadata-Version: 2.1
Name: fluxpoint.py
Version: 0.1.1
Summary: A Python wrapper for the Fluxpoint API
Home-page: https://github.com/Dhruvacube/fluxpoint.py
Author: Dhruva Shaw
License: GNU GENERAL PUBLIC LICENSE
Project-URL: fluxpoint.py API wrapper Docs, https://fluxpointpy.readthedocs.io
Project-URL: Official Api Docs, https://bluedocs.page/fluxpoint-api
Project-URL: Get Api Token, https://fluxpoint.dev/api/access
Project-URL: Offcial Fluxpoint discord server, https://discord.gg/fluxpoint
Project-URL: Support server for api wrapper, https://discord.gg/vfXHwS3nmQ
Project-URL: Repository, https://github.com/Dhruvacube/fluxpoint.py
Project-URL: Examples Directory, https://github.com/Dhruvacube/fluxpoint.py/tree/master/examples
Project-URL: Issue tracker, https://github.com/Dhruvacube/fluxpoint.py/issues
Description: fluxpoint.py
        ================
        
        .. image:: https://discord.com/api/guilds/920190307595874304/embed.png
           :target: https://discord.gg/vfXHwS3nmQ
           :alt: Discord server invite
        .. image:: https://img.shields.io/pypi/v/fluxpoint.py.svg
           :target: https://pypi.python.org/pypi/fluxpoint.py
           :alt: PyPI version info
        .. image:: https://img.shields.io/pypi/pyversions/fluxpoint.py.svg
           :target: https://pypi.python.org/pypi/fluxpoint.py
           :alt: PyPI supported Python versions
        
        A modern, easy to use, feature-rich, and async ready API wrapper for Fluxpoint written in Python.
        
        Key Features
        --------------
        
        - Modern Pythonic API using ``async`` and ``await``.
        - Proper rate limit handling.
        - Optimised in both speed and memory.
        
        Installing
        ----------
        
        **Python 3.8 or higher is required**
        
        To install the library, you can just run the following command:
        
        .. code:: sh
        
            # Linux/macOS
            python3 -m pip install -U fluxpoint.py
        
            # Windows
            py -3 -m pip install -U fluxpoint.py
        
        To speedup the api wrapper you should run the following command:
        
        .. code:: sh
        
            # Linux/macOS
            python3 -m pip install -U "fluxpoint.py[speed]"
        
            # Windows
            py -3 -m pip install -U fluxpoint.py[speed]
        
        
        To install the development version, do the following:
        
        .. code:: sh
        
            $ git clone https://github.com/Dhruvacube/fluxpoint.py
            $ cd fluxpoint.py
            $ python3 -m pip install -U .[speed]
        
        
        Quick Example
        ---------------
        
        .. code:: py
        
              from fluxpoint import FluxpointClient
              import asyncio
              import sys
        
              # setting up the fluxpoint client handler
              a = FluxpointClient(api_token="get api token from https://fluxpoint.dev/api/access")
        
              # setting up the windows loop policy according to the operating system
              if sys.platform.startswith('win32') or sys.platform.startswith('cygwin'):
                  asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
        
              # getting the image url of AZURLANE image
              print(asyncio.run(a.azurlane()))
        
        
        You can find more examples in the `examples directory <https://github.com/Dhruvacube/fluxpoint.py/tree/master/examples>`_.
        
        Links
        ------
        
        - `Documentation <https://fluxpointpy.readthedocs.io/en/latest/>`_
        - `Official Support Discord Server <https://discord.gg/vfXHwS3nmQ>`_
        - `Official Fluxpoint server <https://discord.gg/fluxpoint>`_
        - `Get Fluxpoint api access <https://fluxpoint.dev/api/access>`_
        - `Official Fluxpoint api docs <https://bluedocs.page/fluxpoint-api>`_
        
Keywords: fluxpoint api,api,wrapper,async wrapper
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet
Classifier: Topic :: Communications
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Provides-Extra: speed
Provides-Extra: docs
