Skip to main content

A language-agnostic dependency manager using Git.

Project description

Build Status
Coverage Status
Scrutinizer Code Quality
PyPI Version
PyPI Downloads

Getting Started

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.

Requirements

  • Python 3.4+

  • Latest version of Git (with stored credentials)

  • OSX/Linux (with a decent shell for Git)

Installation

GitMan can be installed 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

Setup

Create a configuration file (gitman.yml or .gitman.yml) in the root of your working tree:

location: vendor
sources:
- repo: https://github.com/kstenerud/iOS-Universal-Framework
  dir: framework
  rev: Mk5-end-of-life
- repo: https://github.com/jonreid/XcodeCoverage
  dir: coverage
  rev: master
  link: Tools/XcodeCoverage

Ignore the dependency storage location:

$ echo .gitman >> .gitignore

Basic Usage

See the available commands:

$ gitman --help

Updating Dependencies

Get the latest versions of all dependencies:

$ gitman update

which will essentially:

  1. create a working tree at root/location/dir

  2. fetch from repo and checkout the specified rev

  3. symbolically link each location/dir from root/link (if specified)

  4. repeat for all nested working trees containing a configuration file

  5. record the actual commit SHAs that were checked out (with --lock option)

where rev can be:

  • all or part of a commit SHA: 123def

  • a tag: v1.0

  • a branch: master

  • a rev-parse date: '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

Advanced Options

See the full documentation at git-dependency-manager.info.

Revision History

0.8.3 (2016/03/12)

  • 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 (2015/10/13)

  • Switched to using repository mirrors to speed up cloning.

  • Disabled automatic fetching on install.

  • Added –fetch option on install to always fetch.

  • Now displaying git status output when there are changes.

0.7 (2015/12/22)

  • Fixed git remote rm command (@hdnivara).

  • Now applying the update dependency filter to locking as well.

  • Now only locking previous locked dependencies.

  • Added lock command to manually save all dependency versions.

  • Now requiring –lock option on update to explicitly lock dependencies.

0.6 (2015/11/13)

  • Added the ability to filter the dependency list on install and update.

  • Added –depth option to limit dependency traversal on install, update, and list.

0.5 (2015/10/20)

  • Added Git plugin support via: git deps.

  • Removed –no-clean option (now the default) on install and update.

  • Added –clean option to delete ignored files on install and update.

  • Switched to install rather than update of nested dependencies.

  • Added –all option on update to update all nested dependencies.

  • Disabled warnings when running install without locked sources.

  • Added –no-lock option 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 install command with update.

  • Updated install command to use locked dependency versions.

  • Now sorting sources after a successful update.

  • Now requiring –force to uninstall with uncommitted changes.

  • Updated list command 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-clean option to disable removing untracked files.

  • Added support for rev-parse dates as the dependency rev.

0.2.5 (2015/06/15)

  • Added –quiet option 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 –force when there are untracked files.

0.2 (2015/03/10)

  • Added list command 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 –force argument to:
    • overwrite uncommitted changes

    • create symbolic links in place of directories

  • Added live shell command output with -vv argument.

0.1 (2014/02/24)

  • Initial release.

Project details


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-0.8.3.dev2.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

GitMan-0.8.3.dev2-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file GitMan-0.8.3.dev2.tar.gz.

File metadata

  • Download URL: GitMan-0.8.3.dev2.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for GitMan-0.8.3.dev2.tar.gz
Algorithm Hash digest
SHA256 5eac7c53bbbd02f48e55ef1b920fc94d96c714250cc6cebd830fe518edd96000
MD5 e3a23e8f6262abf190706069ec0088d9
BLAKE2b-256 d7e99c812f64cdca7501c262f1aac12296f2eb4c739978873e10c9941c7e4aa5

See more details on using hashes here.

File details

Details for the file GitMan-0.8.3.dev2-py3-none-any.whl.

File metadata

File hashes

Hashes for GitMan-0.8.3.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 c880dbb92b1548d9a00218de76fc4492a541e3efd7498ae1c8d95aa2b3b5a943
MD5 fa48e8394b5c20bac4125b323951db69
BLAKE2b-256 f78abc513e8dd34c38979d1f36394ddc30681713b02be1ae9c97b521b79f9aba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page