Skip to main content

A language-agnostic dependency manager using Git.

Project description

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.

demo

Unix Build Status Windows Build Status Coverage Status Scrutinizer Code Quality PyPI Version PyPI License

Setup

Requirements

Installation

Install this tool globally:

$ pip install gitman

or add it to your Poetry project:

$ poetry add gitman

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/truffleHog.py
  - name: fontawesome
    repo: https://github.com/FortAwesome/Font-Awesome
    sparse_paths:
      - "webfonts/*"
    rev: master
  - name: material-design-icons
    repo: https://github.com/google/material-design-icons.git
    rev: master

groups:
  - name: code
    members:
      - framework
      - trufflehog
  - name: resources
    members:
      - fontawesome
      - material-design-icons

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:

  1. Create a working tree at <root>/<location>/<name>
  2. Fetch from repo and checkout the specified rev
  3. Symbolically link each <location>/<name> from <root>/<link> (if specified)
  4. Repeat for all nested working trees containing a config file
  5. Record the actual commit SHAs that were checked out (with --lock option)
  6. 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: main
  • a rev-parse date: 'main@{2015-06-18 10:30:59}'

Alternatively get the latest versions of certain dependencies or even dependency groups:

  • Update a single repository
$ gitman update framework
  • Update a dependency group
$ gitman update resources

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

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-2.2b1.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

gitman-2.2b1-py3-none-any.whl (36.8 kB view details)

Uploaded Python 3

File details

Details for the file gitman-2.2b1.tar.gz.

File metadata

  • Download URL: gitman-2.2b1.tar.gz
  • Upload date:
  • Size: 30.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.2 Darwin/19.6.0

File hashes

Hashes for gitman-2.2b1.tar.gz
Algorithm Hash digest
SHA256 dbd8bcba03f210f804c3558343296fc0464e00972f9af86ee531a40434c9ae0e
MD5 b62097c7a0318f243a8eea7e38dc88ab
BLAKE2b-256 e0e14bfa396d7a1cc24110544dcb8c2a67ecddb39f6be8a25c7fdc7f61c6fd29

See more details on using hashes here.

File details

Details for the file gitman-2.2b1-py3-none-any.whl.

File metadata

  • Download URL: gitman-2.2b1-py3-none-any.whl
  • Upload date:
  • Size: 36.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.2 Darwin/19.6.0

File hashes

Hashes for gitman-2.2b1-py3-none-any.whl
Algorithm Hash digest
SHA256 4b46b887e1f905986d6e3cf67c8c1d4ce44bf1c359e682bcd294833816f5fdc0
MD5 bc459b81fc58e1653fcbfc9f80525c1e
BLAKE2b-256 9c079f9a2b215eb59943d8a82ec37f6a6373dbccd6cbaeb23d5838a05fad1b10

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