Metadata-Version: 2.1
Name: gpfetcher
Version: 0.3
Summary: A python package that fetches your public project(repos) details from github
Home-page: UNKNOWN
Author: Gautam Chandra Saha
Author-email: devgautam1231@gmail.com
License: UNKNOWN
Keywords: python,github,projects,repositories,JSON
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
Requires-Dist: bs4
Requires-Dist: lxml
Requires-Dist: requests
Requires-Dist: tqdm


# 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)

## Link to the package: [pypi.org/project/gpfetcher](https://pypi.org/project/gpfetcher/)

## Documentation


*Assuming python and pip installed on your system*

- *Checkout resources to install [python](https://www.python.org/downloads/) and [pip](https://packaging.python.org/tutorials/installing-packages/) if not installed*

___
#### Installing the package gpfetcher

For linux and mac
```bash

pip3 install gpfetcher
```


For windows
```bash
pip install gpfetcher 
```


- Then use the package in your python file as shown below 

## Usage

```python
from gpfetcher import scraper

if __name__ == "__main__":
    username = "< github userrname 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

```bash
  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*

___
# Author
## Gautam Chandra Saha

2021 &copy; Gautam Chandra Saha
## License

[MIT](https://choosealicense.com/licenses/mit/)




