msrogers2015 / Just-Enough-Git

Just enough gui to push something to github

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Just Enough Git

GUI with just enough Git to create a repo and commit it to github with branch support
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

I recently started focusing on working on my own projects and what was a better first large-ish scale project than creating a GUI for git?! Rather than recreating the wheel, I decided to focus on those, who like me, are intemidated by (C)ommand (L)ine (I)nterface tools.

All of the git options are seperated into menu options at the top of the app (typically where youd see save, open, things of that nature) and create their own dialog box when information needs to be passed with the exception of full commit messages. The goal is to impliment enough of git that any new user can get started quickly and have enough at their disposal to work on a single person project.

(back to top)

Built With

  • Python using only built in packages
  • Git for all the hard work in the background

(back to top)

Getting Started

Only thing you need is python and git installed. I will warn you to check your tkinter install, it seems that sometimes it's not installed and youd need to install it yourself (i believe it's an option in the python installer that needs to be selected when first installing python.)

Installation

  1. Ensure git and python is installed via their installers.
  2. Clone the repo
    git clone https://github.com/msrogers2015/Just-Enough-Git.git
  3. Run the main.py file from a terminal
    python main.py
    Alternatively double click the run.bat file (do not move this file as it is path dependent)

(back to top)

Usage

From the Setup menu you can start or downlaod git repos. You also have the ability yo change the information displayed on github when you push a git( name and email) The Staging menu allows you to add and remove files form the stage as well as get the current status and see changes and commit your changes. The branches menu allow users to switch between branches. Lastly the Update menu updates your local repo by allowing you to pull adn getch or update remote repo by pushing your commits

(back to top)

Roadmap

  • Init and Clone Repos
  • Update User Info (Name and Email)
  • Get Status
  • Stage/Unstage files
    • Show unstaged file history
  • Full Commit
    • Quick Commit
  • List Branches
  • Create Branch
  • Switch Branches
  • Merge Branches
  • Commit History
    • Compare Commits
    • Compare Changes
  • Fetch command
  • Pull command
  • Merge command
  • Push command
  • Track Files
    • Show tracking log
    • Ad and remove files from project

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Since this is my first project I would like to keep contributing closed but I do plan on creating a full featured version with all the additional git commands such as rebase, allowing the switching between merge types (i.e three way merge), etc. There is currently an empty repo for this named Get Good with Git.

If you have a suggestion that would make this better, please open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Marquel Rogers - rogersmar2015@gmail.com

Project Link: https://github.com/msrogers2015/Just-Enough-Git

(back to top)

About

Just enough gui to push something to github

License:MIT License


Languages

Language:Python 100.0%Language:Batchfile 0.0%