GitInstaller

Installs GitHub packages to your current directory using Python3.

Install using pip3

pip3 install git-install

... or manually install GitInstaller

1. Clone the respository:

git clone https://github.com/ychnlgy/GitInstaller.git

2. Enter the GitInstaller/ folder.
3. Run the installation script:

python3 install.py

How to use the binary:

• This guide assumes you have installed GitInstaller via pip3, which installs git-install.py in your bin directory.
• If you installed GitInstaller manually, the binary will be in your local directory. Therefore you have to run the binary in one of two ways (to see the version in the following examples):

./git-install.py --version

python3 git-install.py --version

Uninstall

git-install.py --uninstall ychnlgy/GitInstaller

Quickstart

• Install package ychnlgy/StdC:

git-install.py ychnlgy/StdC

• Uninstall ychnlgy/StdC:

git-install.py --uninstall ychnlgy/StdC

• To remove all installed packages, do:

git-install.py --removeall

Additional features

• List all installed packages:

git-install.py --list

• Reinstall a package:

git-install.py --reinstall ychnlgy/StdC

• Install the required packages specified in git-install.ini (see below):

git-install.py --setup

What is git-install.ini?

For a C++ project that depends on ychnlgy/StdC and ychnlgy/CakeBaker, you would typically write:

INCLUDE = *.cpp *.h
EXCLUDE = */tests
REQUIRE = ychnlgy/StdC ychnlgy/CakeBaker

Here is a detailed explanation of the fields (which accept multiple space-separated arguments):

* Note: any file that is excluded or not included is deleted during installation.

How to set up your own git-installable package (3 steps):

1. Make sure that packaged files are within a subfolder of the same name - but lower case! This means if your package is ychnlgy/StdC, the GitHub repository should contain stdc/ at its root directory. Other files or folders are deleted during installation!
2. Write a git-install.ini containing the patterns of included and excluded files, and all git-installable dependencies.
3. Push to GitHub.

What is git-installed.log?

It stores the names of all git-installed packages so git-install.py --uninstall and git-install.py --removeall do not accidently delete your important folders.