Metadata-Version: 2.1
Name: gh-subdir
Version: 0.1.9
Summary: A Python module for installing GitHub subdirectories.
Home-page: https://github.com/reecevela/gh-subdir-py
Author: Reece Vela
Author-email: reecevela@outlook.com
License: GPLv3
Description: # gh_subdir
        Python module to install a subfolder of a github repo instead of the entire repo.
        
        ## How to use
        
        Have the gh_subdir.py file in the same directory as your python file, then follow the example below.
        
        ```python
        from gh_subdir import gh_subdir
        ghs_config = {
            "owner": "example_owner",
            "repo": "example_repo",
            "encoding": "utf-8", # optional (default: utf-8)
            "create_subfolder": True, # optional (default: True)
        }
        ghs = gh_subdir(ghs_config)
        ghs.install("example_subdir")
        ```
        
        ## Options
        encoding: Default encoding for the files, I've found utf-8 handles the most cases, but if you're having issues with encoding, try changing this.
        
        create_subfolder: 
        - If True, the files will be installed in a subfolder with the same name as the subfolder path. 
        - If False, the files will be installed in the same directory as the python file.
        
        
Keywords: github directory download python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
