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 with pipx (or pip):

$ pipx 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:
  - repo: https://github.com/kstenerud/iOS-Universal-Framework
    name: framework
    rev: Mk5-end-of-life
  - repo: https://github.com/jonreid/XcodeCoverage
    name: coverage
    link: Tools/XcodeCoverage
  - repo: https://github.com/dxa4481/truffleHog
    name: trufflehog
    rev: master
    scripts:
      - chmod a+x truffleHog/truffleHog.py
  - repo: https://github.com/FortAwesome/Font-Awesome
    name: fontawesome
    rev: master
    sparse_paths:
      - "webfonts/*"
  - repo: https://github.com/google/material-design-icons.git
    name: material-design-icons
    rev: master

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

default_group: code

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 specific dependencies:

$ gitman update framework

or named groups:

$ gitman update resources

Restoring Previous Versions

Display the versions that are currently installed:

$ gitman list

Reinstall these specific versions at a later time:

$ gitman install

Deleting Dependencies

Remove all installed dependencies:

$ gitman uninstall

Resources

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-3.0a1.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

gitman-3.0a1-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

Details for the file gitman-3.0a1.tar.gz.

File metadata

  • Download URL: gitman-3.0a1.tar.gz
  • Upload date:
  • Size: 30.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Darwin/20.3.0

File hashes

Hashes for gitman-3.0a1.tar.gz
Algorithm Hash digest
SHA256 c65691133125ba37e0ef690b328a665eb6443d3c96b61770fa95dceb8435fa9d
MD5 eb99be469e7e3885cf3fea105f5af706
BLAKE2b-256 13205c6b1470faed0cb6828725637ab69975ee100f7fe4fe924bd19235d55745

See more details on using hashes here.

File details

Details for the file gitman-3.0a1-py3-none-any.whl.

File metadata

  • Download URL: gitman-3.0a1-py3-none-any.whl
  • Upload date:
  • Size: 37.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Darwin/20.3.0

File hashes

Hashes for gitman-3.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 1b95cdb2a420508895cfe41e6c22cfaf3d303ed52a4337713730a510cf8222b6
MD5 9699b37e14ef2f34163b90adf30592a5
BLAKE2b-256 2aae503afb9bd0e4cadd12812d84bc5bee6d28f68eb0e7bb96117e341ad20957

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