Metadata-Version: 2.1
Name: kb4.py
Version: 0.1.2
Summary: A simple Python wrapper for the KnowBe4 API
Home-page: https://github.com/elderlydoofus/knowbe4.py
Author: Josh Thomas
Author-email: josh@joshuadavidthomas.com
License: LICENSE.md
Description: # kb4.py: A Python wrapper for the KnowBe4 API
        
        ![KnowBe4 logo](knowbe4.jpg)
        
        kb4.py is a simple Python wrapper for the KnowBe4 reporting API.
        
        For more information on the API, please visit the [KnowBe4 API documentation](https://developer.knowbe4.com/).
        
        ## Installation
        
        ```bash
        pip install kb4.py
        ```
        
        ## Usage
        
        ```python
        from kb4 import KnowBe4
        
        KB4_API_KEY='<Secret key obtained from KnowBe4 website.>'
        
        kb4 = KnowBe4(KB4_API_KEY)
        
        kb4.account()
        kb4.users()
        kb4.user(USER_ID)
        kb4.groups()
        kb4.group(GROUP_ID)
        kb4.group_members(GROUP_ID)
        kb4.phishing_campaigns()
        kb4.phishing_campaign(CAMPAIGN_ID)
        kb4.phishing_security_tests()
        kb4.phishing_campaign_security_tests(CAMPAIGN_ID)
        kb4.phishing_campaign_security_test(PST_ID)
        kb4.phishing_campaign_security_test_recipients(PST_ID)
        kb4.phishing_campaign_security_test_recipient(PST_ID, USER_ID)
        kb4.store_purchases()
        kb4.store_purchase(STORE_PURCHASE_ID)
        kb4.policies()
        kb4.policy(POLICY_ID)
        kb4.training_campaigns()
        kb4.training_campaign(CAMPAIGN_ID)
        kb4.training_enrollments()
        kb4.training_enrollment(ENROLLMENT_ID)
        ```
        
        ## Contributing
        
        All contributions are welcome and appreciated.
        
        1. Fork
        2. Feature branch
        3. Pull request
        
        ## Meta
        
        Josh Thomas - josh@joshuadavidthomas.com
        
        Distributed under the MIT license. See `LICENSE` for more information.
        
        [https://github.com/elderlydoofus/kb4.py](https://github.com/elderlydoofus/kb4.py)
        
Keywords: knowbe4,kb4.py
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
