A language-agnostic dependency manager using Git.
Project description
Unix: 
Metrics: 
Usage:
Overview
GitMan is a language-agnostic dependency manager using Git. It aims to serve as a submodules replacement and provides advanced options for managing versions of nested Git repositories.
Setup
Requirements
- Python 3.5+
- Git 2.8+ (with stored credentials)
Installation
Install GitMan with pip:
$ pip install gitman
or directly from the source code:
$ git clone https://github.com/jacebrowning/gitman.git
$ cd gitman
$ python setup.py install
Configuration
Generate a sample config file:
$ gitman init
or manually create one (gitman.yml or .gitman.yml) in the root of your working tree:
location: vendor/gitman
sources:
- name: framework
repo: https://github.com/kstenerud/iOS-Universal-Framework
rev: Mk5-end-of-life
- name: coverage
repo: https://github.com/jonreid/XcodeCoverage
rev: master
link: Tools/XcodeCoverage
- name: trufflehog
repo: https://github.com/dxa4481/truffleHog
rev: master
scripts:
- chmod a+x truffleHog.py
- name: fontawesome
repo: https://github.com/FortAwesome/Font-Awesome
sparse_paths:
- fonts/*
rev: master
Ignore the dependency storage location:
$ echo vendor/gitman >> .gitignore
Usage
See the available commands:
$ gitman --help
Updating Dependencies
Get the latest versions of all dependencies:
$ gitman update
which will essentially:
- Create a working tree at
<root>/<location>/<name> - Fetch from
repoand checkout the specifiedrev - Symbolically link each
<location>/<name>from<root>/<link>(if specified) - Repeat for all nested working trees containing a config file
- Record the actual commit SHAs that were checked out (with
--lockoption) - Run optional post-install scripts for each dependency
where rev can be:
- all or part of a commit SHA:
123def - a tag:
v1.0 - a branch:
master - a
rev-parsedate:'develop@{2015-06-18 10:30:59}'
Restoring Previous Versions
Display the specific revisions that are currently installed:
$ gitman list
Reinstall these specific versions at a later time:
$ gitman install
Deleting Dependencies
Remove all installed dependencies:
$ gitman uninstall
Revision History
1.5 (2018-09-08)
- Added
--keep-locationoption onuninstall(@DavidWatkins). - Added feature to enable sparse checkouts. See the docs for further information. (@xenji)
- BREAKING: Removed confusing
--lockoption onupdatecommand in favor of just using thelockcommand. - BREAKING: Renamed
--no-lockto--skip-lockonupdatecommand. - BREAKING: Renamed
--no-dirtyto--fail-if-dirtyonlistcommand.
1.4 (2017-03-21)
- Allow config files to exist in subdirectories of the main project.
- Added
${GITMAN_CACHE}to customize the repository cache location.
1.3 (2017-02-03)
- Added
initcommand to generate sample config files. - Added support for post-install scripts on dependencies.
- Updated config format to support
nullfor links.
1.2 (2017-01-08)
- Added preliminary Windows support (@StudioEtrange).
1.1 (2017-01-06)
- Added coloring to the command-line output.
- Fixed issue where
<dirty>could be saved as a locked revision.
1.0.2 (2016-07-28)
- Moved documentation to http://gitman.readthedocs.io/.
1.0.1 (2016-05-31)
- Replaced calls to
git remote add originwithgit remote set-url origin.
1.0 (2016-05-22)
- Initial stable release.
0.11 (2016-05-10)
- Removed dependency on
shto support Cygwin/MinGW/etc. on Windows. - Dropped Python 3.4 support for
subprocessand*argsimprovements. - BREAKING: Renamed config file key
dirtoname.
0.10 (2016-04-14)
- Added
showcommand to display dependency and internal paths.
0.9 (2016-03-31)
- Added
editcommand to launch the config file. - Depth now defaults to 5 to prevent infinite recursion.
- Fixed handling of source lists containing different dependencies.
0.8.3 (2016-03-14)
- Renamed to GitMan.
0.8.2 (2016-02-24)
- Updated to YORM v0.6.
0.8.1 (2016-01-21)
- Added an error message when attempting to lock invalid repositories.
0.8 (2016-01-13)
- Switched to using repository mirrors to speed up cloning.
- Disabled automatic fetching on install.
- Added
--fetchoption oninstallto always fetch. - Now displaying
git statusoutput when there are changes.
0.7 (2015-12-22)
- Fixed
git remote rmcommand (@hdnivara). - Now applying the
updatedependency filter to locking as well. - Now only locking previous locked dependencies.
- Added
lockcommand to manually save all dependency versions. - Now requiring
--lockoption onupdateto explicitly lock dependencies.
0.6 (2015-11-13)
- Added the ability to filter the dependency list on
installandupdate. - Added
--depthoption to limit dependency traversal oninstall,update, andlist.
0.5 (2015-10-20)
- Added Git plugin support via:
git deps. - Removed
--no-cleanoption (now the default) oninstallandupdate. - Added
--cleanoption to delete ignored files oninstallandupdate. - Switched to
installrather thanupdateof nested dependencies. - Added
--alloption onupdateto update all nested dependencies. - Disabled warnings when running
installwithout locked sources. - Added
--no-lockoption to disable version recording.
0.4.2 (2015-10-18)
- Fixed crash when running with some sources missing.
0.4.1 (2015-09-24)
- Switched to cloning for initial working tree creation.
0.4 (2015-09-18)
- Replaced
installcommand withupdate. - Updated
installcommand to use locked dependency versions. - Now sorting sources after a successful
update. - Now requiring
--forcetouninstallwith uncommitted changes. - Updated
listcommand to show full shell commands.
0.3.1 (2015-09-09)
- Ensures files are not needlessly reloaded with newer versions of YORM.
0.3 (2015-06-26)
- Added
--no-cleanoption to disable removing untracked files. - Added support for
rev-parsedates as the dependencyrev.
0.2.5 (2015-06-15)
- Added
--quietoption to hide warnings.
0.2.4 (2015-05-19)
- Now hiding YORM logging bellow warnings.
0.2.3 (2015-05-17)
- Upgraded to YORM v0.4.
0.2.2 (2015-05-04)
- Specified YORM < v0.4.
0.2.1 (2015-03-12)
- Added automatic remote branch tracking in dependencies.
- Now requiring
--forcewhen there are untracked files.
0.2 (2015-03-10)
- Added
listcommand to display current URLs/SHAs.
0.1.4 (2014-02-27)
- Fixed an outdated index when checking for changes.
0.1.3 (2014-02-27)
- Fixed extra whitespace when logging shell output.
0.1.2 (2014-02-27)
- Added
--forceargument to:- overwrite uncommitted changes
- create symbolic links in place of directories
- Added live shell command output with
-vvargument.
0.1 (2014-02-24)
- Initial release.
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
GitMan-1.5.post1.tar.gz
(136.4 kB
view details)
Built Distribution
File details
Details for the file GitMan-1.5.post1.tar.gz.
File metadata
- Download URL: GitMan-1.5.post1.tar.gz
- Upload date:
- Size: 136.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.5.2 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 01dd6511f6c5d39fe071e24b4778a0ee5ebb3e24da3affd728af2f56072696a0 |
|
| MD5 | 3a298276d3984b73649d2da52f7e5d68 |
|
| BLAKE2b-256 | 1e5fd78c78b79163f8003b5aee257bdba07c5fd736288c957f463890f6eae5c3 |
File details
Details for the file GitMan-1.5.post1-py3-none-any.whl.
File metadata
- Download URL: GitMan-1.5.post1-py3-none-any.whl
- Upload date:
- Size: 37.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.5.2 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8c2f3b48523cb1120c704b966d3e78c21724e2cd83d7734e702b4474756fee4c |
|
| MD5 | 835da913e250811e9885998f823db2c6 |
|
| BLAKE2b-256 | d1cc37e69be4813f5a8b316be0410d4e4f6802f72b102d49693f62869caac8e5 |
