Python GUI for Github using the Github API.
Project description
Py Github GUI
A simple graphical user interface for receiving public details of a GitHub profile.
Table of Contents
- Getting Started
- Development
- Running the App
- Deployment
- Contributing
- Versioning
- Authors
- License
- Acknowledgments
Getting Started
The project might have multiple branches: master
, development
, etc. which can be explained here
master
contains aggregate code of all branchesdevelopment
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:
- It's a way to give back to the community. People get to learn from you and appreciate your work
- 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
Authors
Madhur Taneja
You can also see the complete list of contributors who participated in this project.
License
Project Title
is open source software licensed as MIT.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py-github-gui-rackodo-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 651569e250b68bf6f174ae8149be9108602767aea4ecddc2c5719e8f7c46a90c |
|
MD5 | ab9b9a7c08f4cecda9c6758fb51a257b |
|
BLAKE2b-256 | 6c0dfffe82e0e9336348f00f6e4326996093144985334725c63023dbe3fb6d3b |
Hashes for py_github_gui_rackodo-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23e1f398abec4b78876d668885ab7503327a312e63de7b5ee4015085d6e441b8 |
|
MD5 | 867e1dfbdeba4b88b3c595147c8dea92 |
|
BLAKE2b-256 | 49c78864937ed9df618d0c01d8f6e9891268b65731d1fe7760fdcb2ce091e7e4 |