Metadata-Version: 2.1
Name: teachable-school-manager
Version: 1.2.3
Summary: Manage your Teachable school using the unofficial Teachable API
Home-page: https://github.com/stezz/teachable-scripts
Author: Stefano Mosconi
Author-email: stefano.mosconi@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/stezz/teachable-scripts/issues
Project-URL: Source, https://github.com/stezz/teachable-scripts/
Description: # Teachable Scripts
        You'll find here some script to manage your Teachable school using the unofficial Teachable API.
        
        This project was forked from [maxbritto's project](https://github.com/maxbritto/teachable-scripts/) which was itself forked from [buzkall's project](https://github.com/buzkall/teachable-reports-export) (thanks guys!) because of major refactoring and added features which changes the goal of the original project.
        Pull requests are accepted if you want to add new features/apis.
        
        
           
        
        ## Disclaimer
        **This project is unofficial and not supported by Teachable. It is published and made open source in order to help other teachers but it comes with no warranty whatsoever from the author or any contributor.**
        
        Teachable.com doesn't have an official API to manage your school. It has some webhooks to trigger events and use them with services like Zapier, but there is no fast and practical solution to manage your school, especially for large student groups.
        The website is done using Angular, and needs some api urls to load the content, so this project uses those api to collect data and perform actions as if you were using the web admin panel.
        
        **This mean that if Teachable changes their APIs, scripts from this project could stop working and potentially do damage to your school data. At any time. 
        Please take that into consideration before using this project and don't come to me to ask for repairs afterwards ;)** 
        
        ## Install and Config
        This script has been tested with python 3.9
        
        The list of requirements can be found in the Pipfile and you can install them simply by issuing 
        
            pipenv install 
        
        After that you should copy the file called config_example.ini, rename it as config.ini and set your username, password and yout teachable custom domain
            [DEFAULT]
            username=YOUR_TEACHABLE_USERNAME
            password=YOUR_TEACHABLE_PASSWORD
            site_url=https://YOUR_TEACHABLE_URL
        
        alongside all the other variables that you find there
        
        ## Usage
        ### Enroll users to course
        If you want to enroll a whole list of users to a new course, you can do it with this script that receives a user list csv file (you can download those from your school admin panel) and a course id.
        
        Typing --help will show the parameters info
        
            usage: enrollUsers.py [-h] input_file courseId
        
            Mass enroll users from Excel or CSV file into a specified course
        
            positional arguments:
        	  input_file  Excel or CSV file. The only needed columns are 'fullname' and 'email'
        	  courseId    The id of the course they should be enrolled in
        
            optional arguments:
        	  -h, --help  show this help message and exit
        
            ---
        
        If your file is Userlist.xlsx and course id is 1234 you can enroll all the users in the file into this course by typing :
        
            python enrollUsers.py path/to/file/Userlist.xlsx 1234
            
        If some of thoses users are already enrolled in the course, Teachable API currently ignores them.
        
        ### Get User Reports
        
        Typing --help will show the parameters info
        
            usage: getUserReport.py [-h] [--emails EMAILS [EMAILS ...]] [--output_file [OUTPUT_FILE]] [--search [SEARCH]] [--format [FORMAT]] [--detailed]
        
            Get your Teachable students report. By default it will generate a progress summary report of all the students that are enrolled in all your courses. Pay
            attention if you have a lot of students because this will be rate limited at some point
        
            optional arguments:
            -h, --help            show this help message and exit
            --emails EMAILS [EMAILS ...], -e EMAILS [EMAILS ...]
                                list of emails (separated by spaces) - cannot be used with -s
            --output_file [OUTPUT_FILE], -o [OUTPUT_FILE]
                                Output file
            --search [SEARCH], -s [SEARCH]
                                Searches specific text in name or email. For instance -s @gmail.com or -s *@gmail.com will look for all the users that have an
                                email ending in @gmail.com. Or -s Jack will look for all the users that have Jack in their name (or surname) - cannot be used with
                                -e
            --format [FORMAT], -f [FORMAT]
                                Output format (txt or csv)
            --detailed, -d        Get detailed progress report
            
        By default it will generate a progress summary report on screen of all the students that are enrolled in all your courses.
        
        If you add a specific email it will generate the student summary for the specific email or emails on screen.
        
            python getUserReport.py -e STUDENT_EMAIL
            python getUserReport.py -e STUDENT_EMAIL1 STUDENT_EMAIL2
            
        Specifying the output file won't output anything to the screen and will save it into a file:
        
            python getUserReport.py -e STUDENT_EMAIL -o FILENAME.txt
            
        You also can choose to export as a csv file (comma separated values):
        
            python getUserReport.py -e STUDENT_EMAIL -o FILENAME.csv -f csv
            
        If you want a detailed report of the activity of a student or all the students just use the -d flag. For instance:
           
            python getUserReport.py -e STUDENT_EMAIL -o FILENAME.csv -f csv -d
        
        If you want to do a lazy search of all the students with a specific name or email you can use the flag -s (which can't be used with the flag -e). For instance if you want to search for all the users with a @gmail.com address or named Martin:
        
            python getUserReport.py -s @gmail.com -o FILENAME.csv -f csv -d
            python getUserReport.py -s Martin -o FILENAME.csv -f csv -d
            
        ## Get Leaderboard directly from Teachable site
        
        With the function getLeaderboardCSV.py you can get the Leaderboard, i.e. the Summary of the progress report for all the students enrolled in a specific course with just one API call.
        
            Calling python getLeadearboardCSV.py --help will show:
        
                usage: getLeaderboardCSV.py [-h] [--search [SEARCH]]
        
            Get a Leaderboard CSV in just one command. It will save as many leaderboards CSV as you have courses.
        
            optional arguments:
              -h, --help            show this help message and exit
              --search [SEARCH], -s [SEARCH]
                                    Searches specific text in the name of the course
              --output-file [FILENAME], -o [FILENAME
                                    Specify the output file
           
        By default this will generate leaderboards for all the courses in your school. If you want to generate the leaderboard for a specific course you can use
        
            python getLeaderboardCSV.py -s PART_OF_THE_NAME_OF_YOUR_COURSE
            
        You can also specify an output file name by using the -o:
        
            python getLeaderboardCSV.py -o leaders.csv
            
        
        ## Cache and rate limits
        To avoid reaching any rate limit, the script caches the courses' data into a file using Shelve.
        
        The cache path can be changed modifying the variable CACHE_PATH, by default it creates a file called teachable_cache.out in the same folder
        
        The default cache file expiration is set to 3 days in the config_example.ini, but you can configure that how you want.
        
Keywords: scripts teachable
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >3.7, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
