GIG : GitIgnore Generator [Umaintained]
This project is no longer maintained, feel free to fork it and make your own changes.
Generate language/framework specific .gitignore from the comfort of your terminal. This is a work in progress.
What is this?
A simple CLI tool to generate .gitignore files for your projects. It can generate .gitignore files specific to more than 100 languages or frameworks.
Why use this?
Have you ever forgotten to add a .gitignore file while creating a new repository on github and then you have write a new .gitignore from scratch. Well this tool saves you the trouble of going through that.
So if you spend a lot of time on your terminal and are a bit forgetfull you might find this tool useful.
Usage
Just cd into your project repository and type gig --lang <language-or-framework>
For e.g to generate a gitignore for a haskell project type gig --lang Haskell
See it in action
Requirements
- Python 3
- Click
System Wide Installation
$ git clone <this-repo>
$ cd GIG
$ pip install --editable . (Use the editable flag if you want to hack on it make changes otherwise don't)
Installation using virtualenv (Recommended)
An installing using virtualenv is always reccomended so that there are no conflicts with other modules and packages
Fisrt you need to install virtualenv, if you don't already have one. Install it using the following command:
$ python3 -m pip3 install --user virtualenv
Then you need to create a virtual environment. To create a virtual environment, go to your project’s directory and run virtualenv using the following command:
$ python3 -m virtualenv env
Before you can start installing or using packages in your virtualenv you’ll need to activate it. Run the following command to activate virtualenv:
$ source env/bin/activate
Now, to install the required packages follow the instructions as mentioned under the section System-wide installation.
ToDo
- Add checks for pre-existing
.gitignorefiles and uninitialized repo. - Add warning messages for the user.
- Add docstrings and man page.
- PEP8ify the code.
- Refactoring and cleanup.
- Package and publish on PyPy