Metadata-Version: 2.1
Name: py-github-gui-rackodo
Version: 1.1.0
Summary: Python GUI for Github using the Github API.
Home-page: https://github.com/rackodo/py-github-gui
Author: Bash Elliott
Author-email: rackodo.business@gmail.com
Project-URL: Bug Tracker, https://github.com/rackodo/py-github-gui/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: Pillow (==9.5.0)
Requires-Dist: PyGithub (==1.58.1)
Requires-Dist: requests (==2.28.2)
Requires-Dist: url-normalize (==1.4.3)

# Py Github GUI
A simple graphical user interface for receiving public details of a GitHub profile.

![showcase](animatedshowcase.gif)

![Current Version](https://img.shields.io/badge/version-v0.1-blue)
![GitHub stars](https://img.shields.io/github/stars/rackodo/py-github-gui?style=social)
![GitHub forks](https://img.shields.io/github/forks/rackodo/py-github-gui?style=social)
![Twitter Follow](https://img.shields.io/twitter/follow/rackodo?style=social)

## Table of Contents
- [Getting Started](#getting-started)
	- [Tools Required](#tools-required)
	- [Installation](#installation)
- [Development](#development)
    - [Part 1: Heading](#part-1-heading)
	  - [Step 1: Subheading](#step-1-subheading)
	  - [Step 2: Subheading](#step-2-subheading)
	- [Part 2: Heading](#part-2-heading)
- [Running the App](#running-the-app)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Acknowledgments](#acknowledgments)

## Getting Started

The project might have multiple branches: `master`, `development`, etc. which can be explained here

* `master` contains aggregate code of all branches
* `development` contains code under development

Other details that need to be given while starting out with the project can be provided in this section. A project structure like below can also be included for the big projects:

```
	project-title
	├── README.md
	├── package.json
	├── .gitignore
	├── public
	│   ├── favicon.ico
	│   ├── index.html
	│   └── manifest.json
	└── src
		├── App.css
		├── App.js
		├── App.test.js
		├── index.css
		├── index.js
		├── logo.svg
		└── serviceWorker.js
		└── setupTests.js
```

### Tools Required

All tools required go here. You would require the following tools to develop and run the project:

* A text editor or an IDE (like IntelliJ)
* Mention the other tools required for the project 

### Installation

All installation steps go here.

* Installing a particular tool
  * Steps to complete it
  
* Installing another tool

## Development

This section is completely optional. For big projects, the developement strategies are not discussed. But for small projects, you can give some insight to people. It has 2 benefits in my opinion:

1. It's a way to give back to the community. People get to learn from you and appreciate your work
2. You can refer the README in future as a quick refresher before an interview or for an old project to check if it can help you in your currect work

### Part 1: Heading

#### Step 1: Subheading

* Mention the steps here
  * You can also have nested steps to break a step into small tasks
  
#### Step 2: Subheading

* Mention the steps here.
  * You can also have nested steps to break a step into small tasks

For details now how everything has been implemented, refer the source code

### Part 2: Heading

* Mention the steps here

## Running the App

Steps and commands for running the app are to be included here

* Example steps:
  ```
    Example command
  ```

## Deployment

This section is completely optional. Add additional notes about how to deploy this on a live system

## Contributing

Mention what you expect from the people who want to contribute

We'd love to have your helping hand on `Project Title`! See [CONTRIBUTING.md] for more information on what we're looking for and how to get started.

## Versioning

If your project has multiple versions, include information about it here. 

For the available versions, see the [tags on this repository][tags]

## Authors

#### Madhur Taneja
* [GitHub]
* [LinkedIn]

You can also see the complete [list of contributors][contributors] who participated in this project.

## License

`Project Title` is open source software [licensed as MIT][license].

## Acknowledgments

This section can also be called as `Resources` or `References`

* Code Honor if someone's work was referred to
* Tutorials followed
* Articles that helped
* Inspiration
* etc

[//]: # (HyperLinks)

[GitHub Repository]: https://github.com/madhur-taneja/README-Template
[GitHub Pages]: https://madhur-taneja.github.io/README-Template
[CONTRIBUTING.md]: https://github.com/madhur-taneja/README-template/blob/master/CONTRIBUTING.md
[tags]: https://github.com/madhur-taneja/README-template/tags

[GitHub]: https://github.com/madhur-taneja
[LinkedIn]: https://www.linkedin.com/in/madhur-taneja/

[contributors]: https://github.com/madhur-taneja/README-template/contributors
[license]: https://github.com/madhur-taneja/README-template/blob/master/LICENSE.md
