Skip to main content

Git-ignore

Gitignore Template Generator. | 日本語記事
Git-ignore helps you to generate .gitignore file based on templates.
You can install it with ease, and customize with your own templates.

Try it now, and leave me a start if you like it. ☆ ヽ(^ω^ #)

Install

$ pip install git-ignore

Usage

Example: Django project that uses Python and Sass.

$ git-ignore python sass

This will create a .gitignore file that comes from both Python and Sass gitignore templates.

Note that you can add multiple templates at once. Also, it is not case sensitive.

Example: When you want to just add a few lines.

$ git-ignore --add !.keep !.gitkeep

This will add two lines on the bottom of your .gitignore file.

Example: Use custom templates.

$ mkdir ~/.gitignore_templates
$ echo '.DS_Store' > ~/.gitignore_templates/macOS.gitignore
$ git-ignore macOS

Running this, the command will look up at ~/.gitignore_templates/, and try to use ~/.gitignore_templates/macOS.gitignore.

And more...

Find the full list of options by running

$ git-ignore --help

How it works

This tool uses templates from GitHub's .gitignore Templates Collection.

Thus it supports:

Perl6, Sass, Scala, Joomla, CakePHP, Go, Yeoman, ZendFramework, KiCad, Textpattern, ExpressionEngine, Typo3, Packer, Elisp, EPiServer, Gcov, Haskell, GWT, LabVIEW, C++, Objective-C, Composer, SketchUp, Eagle, Android, Symfony, ExtJs, Erlang, Finale, Sdcc, Scrivener, Qooxdoo, RhodesRhomobile, PlayFramework, Stella, SugarCRM, Delphi, TurboGears2, Waf, Leiningen, Dart, R, ChefCookbook, MetaProgrammingSystem, CFWheels, Lilypond, Processing, Kohana, Clojure, GitBook, Lithium, Magento, Node, Python, Nim, Terraform, Yii, Nanoc, Umbraco, DM, Java, Elixir, WordPress, Godot, Xojo, ArchLinuxPackages, Jekyll, Ada, D, Elm, Actionscript, Swift, Grails, Laravel, Perl, CMake, VVVV, VisualStudio, CraftCMS, Coq, Rust, Scheme, IGORPro, Drupal, Plone, AppEngine, Mercury, Jboss, Lua, PureScript, CUDA, AppceleratorTitanium, Concrete5, CodeIgniter, Fortran, Julia, ForceDotCom, OracleForms, Smalltalk, Rails, Phalcon, Prestashop, Agda, Unity, FuelPHP, LemonStand, SeamGen, SCons, SymphonyCMS, CommonLisp, Gradle, Maven, Ruby, OpenCart, Fancy, TeX, Zephir, OCaml, UnrealEngine, Autotools, C, Kotlin, Qt, ROS, Idris, Opa

Features

  • ✔︎ Add .gitignore from templates.
  • ✔︎ Can add multiple templates at once.
  • ✔︎ Based on GitHub's templates collection.
  • ✔︎ Support "Global (operating system or editor specific) templates".
  • ✔︎ Helpful --help option.
  • ✔︎ User defined template.

Contributing

Issues and PRs are welcome :)

License

MIT

Release files for git-ignore 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for git-ignore 1.0.2
File Size Uploaded
git-ignore-1.0.2.tar.gz 32.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for git-ignore 1.0.2
File Interpreter ABI Platform
git_ignore-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 93.1 kB

Release files / git-ignore-1.0.2.tar.gz

Download URL git-ignore-1.0.2.tar.gz
Size 32.4 kB
Tags Source
SHA-256 checksum
How to use checksums
180e692dbf45fcb9571a665249921a7b0e609752a0ffab67aa38d28793816ba2
BLAKE2b-256 checksum
How to use checksums
9d862d1048de891920afb27189626c2d94bfbacda6c9ed1f4fa592cb120c1626
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.8

Release files / git_ignore-1.0.2-py3-none-any.whl

Download URL git_ignore-1.0.2-py3-none-any.whl
Size 60.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0644a8c51bb76bb46619bc0b8f037d485dafa98498fd22b09a1cf80c6cc11499
BLAKE2b-256 checksum
How to use checksums
94576218f0639771ad046eac3e1d287b9daadd6d8aee6275c1c228ee5ada6049
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.8

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.2.2

2 release files

0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page