Metadata-Version: 2.1
Name: growstocks
Version: 1.2.0
Summary: A wrapper for the GrowStocks API, made for both synchronous and asynchronous applications.
Home-page: https://github.com/BobDotCom/growstocks
Author: BobDotCom
Author-email: bobdotcomgt@gmail.com
License: MIT
Download-URL: https://github.com/BobDotCom/growstocks/releases
Project-URL: Documentation, https://growstocks.readthedocs.io/en/latest/index.html
Project-URL: Source, https://github.com/BobDotCom/growstocks
Project-URL: Tracker, https://github.com/BobDotCom/growstocks/issues
Platform: UNKNOWN
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 :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE

===================
growstocks 1.2.0
===================

A wrapper for the GrowStocks API, made for both synchronous and asynchronous applications.

|Status badge| |Docs badge| |Downloads badge|

.. |Status badge| image:: https://github.com/BobDotCom/growstocks/workflows/Python%20Package/badge.svg
   :target: https://github.com/BobDotCom/growstocks/actions?query=workflow%3A"Python+Package"
   :alt: Package Status

.. |Docs badge| image:: https://readthedocs.org/projects/growstocks/badge/?version=latest
   :target: https://growstocks.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. |Downloads badge| image:: https://static.pepy.tech/personalized-badge/growstocks?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads
   :target: https://pepy.tech/project/growstocks
   :alt: Download Counter

PyPI: https://pypi.org/project/growstocks/

Docs: https://growstocks.readthedocs.io/en/latest/

Installation
############
You can install released versions of growstocks from the Python Package Index via pip or a similar tool:

**Stable Release:** ``pip install growstocks``

**Working Version:** ``pip install git+https://github.com/BobDotCom/growstocks.git``

Usage
#####

.. code-block:: python

    >>> import growstocks
    >>> client = growstocks.Client(913117854995652992,"T%GRD4iEiFmgyYE!O5&ZCx3Rn%uqwPV3")
    >>> client.default_scopes = growstocks.Scopes(profile=True, balance=True, discord=True)
    >>> user = client.auth.fetch_user('31G4k57rG3asdyyi5Lqk')
    >>> dict(user)
    {'discord_id': '690420846774321221',
     'id': 1916,
     'name': 'BobDotCom',
     'email': None,
     'growid': 'Bob430',
     'balance': 3}

Using Async
###########
To use in an async context, just use ``import growstocks.aio as growstocks`` as your import and make sure to await the functions marked as coroutines.

.. code-block:: python

    import growstocks.aio as growstocks

