Metadata-Version: 2.1
Name: github-crawler
Version: 0.0.6
Summary: A web spider to crawl public github repositories
Home-page: https://github.com/karthikhosur/Github-Crawler
Author: Karthik Hosur
Author-email: karthikhosur15@gmail.com
License: UNKNOWN
Description: 
        
        # Github Crawler
        
        ```
        A web spider to crawl public github repositories
        ```
        
        Built with ❤︎ and :coffee: by  [Karthik Hosur](https://github.com/karthikhosur)
        
        ---
        ```
        A web spider to crawl public github repositories to collect data of github user profiles,repositories and user social counts for educational purpose only. The project was earlier built to collect data from github for academic data analysis project.
        ```
        
        # Features
        
        - Extract User Social Status 
        - Extract Repository Names
        - Extract User Activity
        - Extract Repository Social Information
        - Extract Repository Data
        
        # Installation
        
        - You can install this package using
        
        ```bash
        pip install github-crawler
        ```
        
        # Usage
        
        ### Extract the profile information of a github user
        
        - Import it in your Python project
        
        ```python
        from github_crawler import user_profile
        
        github_crawler.user_profile("karthikhosur") # Use the username of the user
        ```
        
        
        ### Result
        
        The module would return a dictionary with result as follows:
        
        ```
        {'followers': 2,
         'following': 4,
         'stars': 5,
         'repositories': ['/karthikhosur/Github-Crawler',
          '/karthikhosur/FairCV',
          '/karthikhosur/Stop-Words-Remover-API',
          '/karthikhosur/BlogsParser-API',
        ```
        
        
        ### Extract a Repository information 
        
        - Import it in your Python project
        
        ```python
        from github_crawler import repo_info
        
        github_crawler.repo_info("/karthikhosur/Github-Crawler")# Use the username with the repository name in the format given
        
        ```
        
        ### Result
        
        The module would return a dictionary with result as follows:
        
        ```
        {'watchers': 1, 'stargazers': 1, 'forks': 1}
        ```
        
        
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
