Metadata-Version: 2.1
Name: snusbase.py
Version: 1.0.1
Summary: an un-official async wrapper for the Snusbase API
Author: igna
License: MIT
Project-URL: Website, https://snusbase.com
Project-URL: Issue tracker, https://github.com/obstructive/snusbase.py
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.6.0
License-File: LICENSE
Requires-Dist: aiohttp (<4,>=3.8.5)
Requires-Dist: orjson (<4,>=3.9.2)
Requires-Dist: pydantic (<3,>=2.1.1)

snusbase.py
================

   an un-official async wrapper for the Snusbase API

Features
========

- none. just easier to use instead of ugly non-async examples

Install
=======

.. code:: sh

   # Linux/macOS
   python3 -m pip install -U snusbase.py

   # Windows
   py -3 -m pip install -U snusbase.py

To install the development version, do the following:

.. code:: sh

    $ pip install -U git+https://github.com/obstructive/snusbase.py

Optional Packages
-----------------

-  `aiodns <https://pypi.org/project/aiodns>`__,
   `brotlipy <https://pypi.org/project/brotlipy>`__,
   `cchardet <https://pypi.org/project/cchardet>`__ (for aiohttp
   speedup)

Quick Example
=============

.. code:: py

   from snusbase import SnusbaseAPI
   from asyncio import get_event_loop

   client = SnusbaseAPI("token")


   async def main():
       result = await client.search_by_username("example")
       print(result)


   loop = get_event_loop()
   loop.run_until_complete(main())

Links
=====
-  `Issues <https://github.com/obstructive/snusbase.py>`__
-  `Snusbase API <https://docs.snusbase.com/>`__
