Metadata-Version: 2.1
Name: allen-py-client
Version: 1.0.12
Summary: Unofficial python wrapper for Allen's web API.
Home-page: https://github.com/lamergameryt/allen-py-client
Author: Harsh Patil
Author-email: ifung230@gmail.com
License: UNKNOWN
Download-URL: https://github.com/lamergameryt/allen-py-client
Keywords: python,allen
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
License-File: LICENSE

=============
AllenPyClient
=============

AllenPyClient is an unofficial Python wrapper to develop applications integrating Allen's official web API.

|PyPi| |Docs| |License| |Followers|

.. |License| image:: https://img.shields.io/github/license/lamergameryt/allen-py-client
.. |Followers| image:: https://img.shields.io/github/followers/lamergameryt?style=social
.. |PyPi| image:: https://badge.fury.io/py/allen-py-client.svg
    :target: https://badge.fury.io/py/allen-py-client
.. |Docs| image:: https://readthedocs.org/projects/allenpyclient/badge/?version=latest
    :target: https://allenpyclient.readthedocs.io/en/latest/?badge=latest

⏩ Quick Example
----------------

In this example, we will fetch the links of the videos available to us.

``main.py``

.. code-block:: python

    from allen import AllenClient
    import os

    env = os.environ
    user = env['user']
    passwd = env['passwd']

    client = AllenClient(username=user, password=passwd)
    videos = client.get_recorded_videos()
    for video in videos:
        link = video.get_link()

        # Print the video link with the subject name and recording date
        print(f'{video.subject_name} ({video.get_recording_date()}) - {link}')


👩‍🏫 Installation
------------------

::

    pip install allen-py-client

📈 Required Python Modules
--------------------------

The list of required python modules can be found in the ``requirements.txt`` file.


