Skip to main content

A python package that fetches your public project(repos) details from github

Project description

Github Projects Fetcher (gp-fetcher)

  • This a tool to fetch your github project details so that your time for writing an API is saved.
  • Simple to use tool made in Python with bs4(Beautiful Soup)

Supports Apple Silicon Macs

Install the latest version to get full support

Link to the package: pypi.org/project/gpfetcher

Only if you want to skip the documentation then checkout this video here

Documentation

Assuming python and pip installed on your system

  • Checkout resources to install python and pip if not installed

Installing the package gpfetcher

For linux and mac

pip3 install gpfetcher

For windows

pip install gpfetcher
  • Then use the package in your python file as shown below

Usage

from gpfetcher import scraper

if __name__ == "__main__":
    username = "< github username here >"
    scraper.scrape(username)
  • After you get the message below, check your root where your .py file is , a json file is generated that can be used in your projects
  Done! checkout your {github-username-here}-projects.json file at the root of this project directory
You are done!

go ahead and use this json to parse in your project

Sample Output

{
    "gp-fetcher": {
        "src": "https://github.com//DevGautam2000/gp-fetcher",
        "about": "You don't want to spend a lot of time just writing a block of code for fetching your projects from github.
        So, go ahead and use this python package to make your life easier",
        "tech_stack": [
            "Python"
        ],
        "license": "MIT License",
        "stars": "",
        "forked_by": ""
    },
    "infoScraper": {
        "src": "https://github.com//DevGautam2000/infoScraper",
        "about": "Scraper written in Python using bs4 to scrape results from SMIT results",
        "tech_stack": [
            "Python"
        ],
        "license": "MIT License",
        "stars": "",
        "forked_by": ""
    },
    "results-web": {
        "src": "https://github.com//DevGautam2000/results-web",
        "about": "The web app for Results",
        "tech_stack": [
            "JavaScript"
        ],
        "license": "",
        "stars": "",
        "forked_by": ""
    },
    "results.github.io": {
        "src": "https://github.com//DevGautam2000/results.github.io",
        "about": "",
        "tech_stack": [
            "Python"
        ],
        "license": "",
        "stars": "",
        "forked_by": ""
    },
    "resume": {
        "src": "https://github.com//DevGautam2000/resume",
        "about": "",
        "tech_stack": [
            "JavaScript"
        ],
        "license": "",
        "stars": "",
        "forked_by": ""
    },
    "DevGautam2000": {
        "src": "https://github.com//DevGautam2000/DevGautam2000",
        "about": "Config files for my GitHub profile.",
        "tech_stack": [],
        "license": "",
        "stars": "",
        "forked_by": ""
    },
  • Also fetches the forked repos separately
       "forked_by": ""
    },
    "FORKED": {
        "Making-Musical-Apps": {
            "src": "https://github.com//DevGautam2000/Making-Musical-Apps",
            "about": "Resources for the O'Reilly book \"Making Musical Apps\"",
            "tech_stack": [
                "Pure Data"
            ],
            "license": "",
            "from": "Forked from nettoyeurny/Making-Musical-Apps",
            "stars": ""
        },
        "Simple-Guitar-Tuner": {
            "src": "https://github.com//DevGautam2000/Simple-Guitar-Tuner",
            "about": "Android app",
            "tech_stack": [
                "Java"
            ],
            "license": "",
            "from": "Forked from siemanko/Simple-Guitar-Tuner",
            "stars": ""
        }
    }
}

Author

Gautam Chandra Saha

2021 © Gautam Chandra Saha

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gpfetcher-0.8.6.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gpfetcher-0.8.6-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file gpfetcher-0.8.6.tar.gz.

File metadata

  • Download URL: gpfetcher-0.8.6.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for gpfetcher-0.8.6.tar.gz
Algorithm Hash digest
SHA256 0a8e0949b5cdbe798ff9009d9614caa7918e4bfa5f67c17708ee1b0f494376bc
MD5 b80ee8b7de059eb9f925e3a1eb6231c1
BLAKE2b-256 f2962de67f0a62561acd5dd31cf018acfda544e80c555f9a902a78d238efa52f

See more details on using hashes here.

File details

Details for the file gpfetcher-0.8.6-py3-none-any.whl.

File metadata

  • Download URL: gpfetcher-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for gpfetcher-0.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2bf650a8295327cb3e8a3233e9426bb7ee4c06b477159dec39fa3ee7ebf8d98b
MD5 9f1994d82e7f535f17cd60697de66fe2
BLAKE2b-256 55e607c6561e57ca57f4f39d6095089278947dcafa4868d4a39cc254e19a8316

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page