Metadata-Version: 1.2
Name: clubhouse-lib
Version: 1.0.0
Summary: The unofficial Python client library for the Clubhouse API.
Home-page: https://github.com/huntrar/python-clubhouse-lib
Author: Hunter H
Author-email: huntrar@gmail.com
Maintainer: Hunter H
Maintainer-email: huntrar@gmail.com
License: MIT
Description: 
        python-clubhouse-lib |PyPI Version| |Total Downloads|
        =====================================================
        
        The unofficial Python client library for the Clubhouse API.
        -----------------------------------------------------------
        
        python-clubhouse-lib is a Python wrapper around the Clubhouse API. It leverages
        typed dicts to better provide utility to the programmer when dealing with
        Clubhouse data. This library only provides the basic glue between your
        application and Clubhouse, and it doesn't attempt to do anything more than that.
        
        Installation
        ------------
        
        ::
        
            pip install clubhouse-lib
        
        or
        
        ::
        
            git clone https://github.com/huntrar/python-clubhouse-lib
            cd clubhouse_lib
            python setup.py install
        
        Examples
        --------
        
        Initializing the client
        
        ::
        
            import clubhouse_lib, os
            cc = clubhouse_lib.ClubhouseClient(os.environ.get('CLUBHOUSE_API_TOKEN'))
        
        Listing Projects
        
        ::
        
            projects = cc.listProjects()
        
        Listing Stories
        
        ::
        
            stories = cc.listStories(projects[0]['id'])
        
        Update Story
        
        ::
        
            cc.updateStory(stories[0]['id'], name='Hello World!')
        
        Contributing
        ------------
        
        This project contains tooling for easily importing documentation from the
        Clubhouse API and converting it into Python.
        
        The API slurper allows you to convert snippets of documentation into JSON
        objects, which can then be digested by the API builder which will build the
        Python code.
        
        We use Black for code formatting. Our flake8 linting configuration is included
        in the repository.
        
        .. |PyPI Version| image:: https://img.shields.io/pypi/v/clubhouse-lib.svg
           :target: https://pypi.python.org/pypi/clubhouse-lib
        .. |Total Downloads| image:: https://pepy.tech/badge/clubhouse-lib
           :target: https://pepy.tech/project/clubhouse-lib
        
        
        News
        ====
        
        1.0.0
        ------
        
         - Publishing the unofficial Python client library for the Clubhouse API.
        
        
        
Keywords: clubhouse clubhouse-lib clubhouse-api
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Bug Tracking
