Metadata-Version: 2.1
Name: learndash
Version: 0.0.5
Summary: A python wrapper for a LearnDash API
Home-page: https://github.com/buildnode/learndash-python
Author: Jorgen Hookham
Author-email: jorgen@buildnode.io
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/buildnode/learndash-python/issues
Description: # LearnDash Python Library
        
        **Warning, early alpha. Most functionality is missing.** The LearnDash Python Library provides a simple wrapper for a LearnDash API.
        
        ## Documentation
        
        See the [LearnDash API V2 Docs](https://developers.learndash.com/rest-api/v2/).
        
        ## Installation
        
        ```bash
        pip install learndash
        ```
        
        ## Usage
        
        ```python
        import learndash
        learndash.api_host = https://my-learndash-website.com
        
        # Auth is provided via wordpress user credentials when needed
        import os
        learndash.wordpress_un = os.environ.get('WORDPRESS_UN')
        learndash.wordpress_pw = os.environ.get('WORDPRESS_PW')
        
        # list Courses
        courses_resp = learndash.Course().list()
        
        print(courses_resp.json())
        
        # retrieve specific Course
        course_resp = learndash.Course(12).retrieve()
        
        print(course_resp.json())
        ```
        
        ## Configuring API Paths
        
        The LearnDash Wordpress plugin allows admins to configure the paths for each API resource. By default, this library will use the LearnDash plugin's default paths, but you can reconfigure those paths:
        
        ```python
        import learndash
        learndash.path_courses = 'courses'  # Leave out slashes
        ```
        
        ## Dependencies
        
        Requires the requests library.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
