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

Git Dependency Manager (GDM) 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

GDM can be installed with pip:

$ pip install gdm

or directly from the source code:

$ git clone https://github.com/jacebrowning/gdm.git
$ cd gdm
$ python setup.py install

Setup

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

location: .gdm
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 GDM’s dependency storage location:

$ echo .gdm >> .gitignore

Basic Usage

See the available commands:

$ gdm --help

Updating Dependencies

Get the latest versions of all dependencies:

$ gdm 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:

$ gdm list

Reinstall these specific versions at a later time:

$ gdm install

Deleting Dependencies

Remove all installed dependencies:

$ gdm uninstall

Advanced Options

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

Revision History

0.8 (unreleased)

  • Switched to using repository mirrors to speed up cloning.

  • Disabled automatic fetching on install.

  • Added –fetch option on install to always fetch.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

GDM-0.8.dev2.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

GDM-0.8.dev2-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file GDM-0.8.dev2.tar.gz.

File metadata

  • Download URL: GDM-0.8.dev2.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for GDM-0.8.dev2.tar.gz
Algorithm Hash digest
SHA256 7a5f0b817196a0cf0b704dae742ec3d8a78eee6687535d4e85796c4d84d2d854
MD5 b6f2e7d7321be694f2d03cd28ee06908
BLAKE2b-256 abc5f46c48ff38ad3168effbbbadfb0ee401fa6428f8d8b1159ef6f4d8eedc30

See more details on using hashes here.

File details

Details for the file GDM-0.8.dev2-py3-none-any.whl.

File metadata

File hashes

Hashes for GDM-0.8.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 ed8c0d7d4cfaabbf5ce9a16caaeaaebc6783b882871187b6dd1ed1056e8aa824
MD5 98fa693ea46ecd5ae06ca94d4f1cf7cb
BLAKE2b-256 0e06b430526ff3772a8b935e070c480d8e8bd9c41efdc7dcf1b1aede61ae9fc5

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