| Name | github-domain-scraper JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | None |
| Summary | This Python package is designed for web crawling through input links that belong to GitHub domains. It offers a wide range of functionalities beyond simple crawling, including the ability to list repositories associated with the provided link, download GitHub repositories, and extract the contents of GitHub repositories. |
| upload_time | 2024-09-13 18:01:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Parth971 (Parth Desai) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
github
crawler
extractor
scraper
github-domain
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# github-domain-scraper
The `github-domain-scraper` is a powerful tool for extracting valuable information from GitHub domains. It provides a
wide
variety of use-cases, making it a versatile solution for various scenarios.
## Installation
You can install the `github-domain-scraper` from [PyPI](https://pypi.org/project/github-domain-scraper/):
```bash
python -m pip install github-domain-scraper
```
The reader is supported on Python 3.8 and above.
## How to use
The `github-domain-scraper` is having wide variety of use-cases
### Command-line Tool
You can use the `github-domain-scraper` as a command-line tool to extract information from GitHub domains:
1. Extracting `Users Repositories` links
```bash
python -m github_domain_scraper --link="https://github.com/Parth971"
```
You can also specify a JSON output file for the results and maximum number of links:
```bash
python -m github_domain_scraper \
--link "https://github.com/Parth971" \
--json output.json \
--max-repositories 10
```
2. Extracting links from `Search result`
```bash
python -m github_domain_scraper --link "https://github.com/search?q=ori+python&type=users"
```
You can also specify a JSON output file for the results and maximum number of links:
```bash
python -m github_domain_scraper \
--link "https://github.com/search?q=ori+python&type=users" \
--json output.json \
--max-repositories 10
```
3. Extracting `User Profile` Information
```bash
python -m github_domain_scraper --github-username <GitHub Username> [<GitHub Username>, ...]
```
You can also specify a JSON output file for the results:
```bash
python -m github_domain_scraper --github-username Parth971
```
```bash
python -m github_domain_scraper \
--github-username Parth971 OrionXV oriana04bedoya oriolval Ailothaen \
--json output.json
```
### Integration in Python Modules
The `github-domain-scraper` can also be seamlessly integrated into other Python modules.
Import the `LinkExtractor` class from `github_domain_scraper.link_extractor` and use it as
follows:
```python
from github_domain_scraper.extractor import LinkExtractor, UserProfileInformationExtractor
links = LinkExtractor(initial_link="github_link").extract()
info = UserProfileInformationExtractor(github_username="Parth971").extract()
```
This makes it easy to incorporate github-domain-scraper functionality into your custom Python projects.
## License
This project is licensed under the MIT License - see the LICENSE.md file for details.
github_domain_scraper.extractor
Raw data
{
"_id": null,
"home_page": null,
"name": "github-domain-scraper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "github, crawler, extractor, scraper, github-domain",
"author": null,
"author_email": "Parth971 <desaiparth971@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f5/92/6aa2a2857451e1051d3eb34636bdeea6e587ccd7e40f8a6020c8db77279a/github_domain_scraper-3.0.0.tar.gz",
"platform": null,
"description": "# github-domain-scraper\n\nThe `github-domain-scraper` is a powerful tool for extracting valuable information from GitHub domains. It provides a\nwide\nvariety of use-cases, making it a versatile solution for various scenarios.\n\n## Installation\n\nYou can install the `github-domain-scraper` from [PyPI](https://pypi.org/project/github-domain-scraper/):\n\n```bash\npython -m pip install github-domain-scraper\n```\n\nThe reader is supported on Python 3.8 and above.\n\n## How to use\n\nThe `github-domain-scraper` is having wide variety of use-cases\n\n### Command-line Tool\n\nYou can use the `github-domain-scraper` as a command-line tool to extract information from GitHub domains:\n\n1. Extracting `Users Repositories` links\n\n ```bash\n python -m github_domain_scraper --link=\"https://github.com/Parth971\"\n ```\n\n You can also specify a JSON output file for the results and maximum number of links:\n \n ```bash\n python -m github_domain_scraper \\\n --link \"https://github.com/Parth971\" \\\n --json output.json \\\n --max-repositories 10\n ```\n\n2. Extracting links from `Search result`\n\n ```bash\n python -m github_domain_scraper --link \"https://github.com/search?q=ori+python&type=users\"\n ```\n\n You can also specify a JSON output file for the results and maximum number of links:\n\n ```bash\n python -m github_domain_scraper \\\n --link \"https://github.com/search?q=ori+python&type=users\" \\\n --json output.json \\\n --max-repositories 10\n ```\n\n3. Extracting `User Profile` Information\n\n ```bash\n python -m github_domain_scraper --github-username <GitHub Username> [<GitHub Username>, ...]\n ```\n\n You can also specify a JSON output file for the results:\n\n ```bash\n python -m github_domain_scraper --github-username Parth971\n ```\n\n ```bash\n python -m github_domain_scraper \\\n --github-username Parth971 OrionXV oriana04bedoya oriolval Ailothaen \\\n --json output.json\n ```\n\n### Integration in Python Modules\n\nThe `github-domain-scraper` can also be seamlessly integrated into other Python modules.\nImport the `LinkExtractor` class from `github_domain_scraper.link_extractor` and use it as\nfollows:\n\n```python\nfrom github_domain_scraper.extractor import LinkExtractor, UserProfileInformationExtractor\n\nlinks = LinkExtractor(initial_link=\"github_link\").extract()\ninfo = UserProfileInformationExtractor(github_username=\"Parth971\").extract()\n```\n\nThis makes it easy to incorporate github-domain-scraper functionality into your custom Python projects.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE.md file for details.\n\ngithub_domain_scraper.extractor\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Parth971 (Parth Desai) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "This Python package is designed for web crawling through input links that belong to GitHub domains. It offers a wide range of functionalities beyond simple crawling, including the ability to list repositories associated with the provided link, download GitHub repositories, and extract the contents of GitHub repositories.",
"version": "3.0.0",
"project_urls": {
"repository": "https://github.com/Parth971/github-domain-scraper"
},
"split_keywords": [
"github",
" crawler",
" extractor",
" scraper",
" github-domain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5662587fb80e8a0b6eea39eba552da0486ebc3b88953c29177f9d2a652b4ea25",
"md5": "f3421e41de360887162123ea5d7095a8",
"sha256": "d9350b61f851f85d0f01cbbeb8fd3c7149f4cd7fb9f4470d939a7426da3d77dc"
},
"downloads": -1,
"filename": "github_domain_scraper-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3421e41de360887162123ea5d7095a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12252,
"upload_time": "2024-09-13T18:01:11",
"upload_time_iso_8601": "2024-09-13T18:01:11.636206Z",
"url": "https://files.pythonhosted.org/packages/56/62/587fb80e8a0b6eea39eba552da0486ebc3b88953c29177f9d2a652b4ea25/github_domain_scraper-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f5926aa2a2857451e1051d3eb34636bdeea6e587ccd7e40f8a6020c8db77279a",
"md5": "bd976e2bb304e9d51a7ff225eef00d37",
"sha256": "40d3c4860622188d03bd460c1f980b492ee87ec88fddc8f7a194ac1039527d78"
},
"downloads": -1,
"filename": "github_domain_scraper-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "bd976e2bb304e9d51a7ff225eef00d37",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11578,
"upload_time": "2024-09-13T18:01:13",
"upload_time_iso_8601": "2024-09-13T18:01:13.374807Z",
"url": "https://files.pythonhosted.org/packages/f5/92/6aa2a2857451e1051d3eb34636bdeea6e587ccd7e40f8a6020c8db77279a/github_domain_scraper-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 18:01:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Parth971",
"github_project": "github-domain-scraper",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "github-domain-scraper"
}
