# gh_subdir
Python module to install a subfolder of a github repo instead of the entire repo.
## How to use
First, install the module with pip.
```bash
pip install gh_subdir
```
Then use the module in your python file as follows:
```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.
## Contributors
Reece Vela - [Github](https://github.com/reecevela)
Others welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/reecevela/gh-subdir-py",
"name": "gh-subdir",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "github directory download python",
"author": "Reece Vela",
"author_email": "reecevela@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/0b/b7/c897a57f871b9697dfa9c1c4a59f4debc70a846bcb817f8ece44b25a6327/gh_subdir-1.0.2.tar.gz",
"platform": null,
"description": "# gh_subdir\nPython module to install a subfolder of a github repo instead of the entire repo.\n\n## How to use\n\nFirst, install the module with pip.\n\n```bash\npip install gh_subdir\n```\n\nThen use the module in your python file as follows:\n\n```python\nfrom gh_subdir import gh_subdir\nghs_config = {\n \"owner\": \"example_owner\",\n \"repo\": \"example_repo\",\n \"encoding\": \"utf-8\", # optional (default: utf-8)\n \"create_subfolder\": True, # optional (default: True)\n}\nghs = gh_subdir(ghs_config)\nghs.install(\"example_subdir\")\n```\n\n## Options\nencoding: 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.\n\ncreate_subfolder: \n- If True, the files will be installed in a subfolder with the same name as the subfolder path. \n- If False, the files will be installed in the same directory as the python file.\n\n## Contributors\n\nReece Vela - [Github](https://github.com/reecevela) \nOthers welcome!",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A Python module for installing GitHub subdirectories.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/reecevela/gh-subdir-py"
},
"split_keywords": [
"github",
"directory",
"download",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0bb7c897a57f871b9697dfa9c1c4a59f4debc70a846bcb817f8ece44b25a6327",
"md5": "7ad1f6fb868b58723c864bb399507966",
"sha256": "4e2e43a7dd4c401dddb8561f86a477333238ae890513a97c3fb0e67de38d6171"
},
"downloads": -1,
"filename": "gh_subdir-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "7ad1f6fb868b58723c864bb399507966",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15206,
"upload_time": "2023-06-12T19:34:28",
"upload_time_iso_8601": "2023-06-12T19:34:28.269804Z",
"url": "https://files.pythonhosted.org/packages/0b/b7/c897a57f871b9697dfa9c1c4a59f4debc70a846bcb817f8ece44b25a6327/gh_subdir-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-12 19:34:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "reecevela",
"github_project": "gh-subdir-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gh-subdir"
}
JSON
