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 License PyPI Version PyPI Downloads

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
    links:
      - target: 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"
    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.4.1b1.tar.gz (32.8 kB view details)

Uploaded Source

Built Distribution

gitman-3.4.1b1-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gitman-3.4.1b1.tar.gz
  • Upload date:
  • Size: 32.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.9.16 Darwin/22.5.0

File hashes

Hashes for gitman-3.4.1b1.tar.gz
Algorithm Hash digest
SHA256 d98228d50db7c425e66ad9cd589623e3763b40b1f14a9a208c98c0e7818e57d5
MD5 5d721c1adf6672cac580cb7a6e5017bc
BLAKE2b-256 afcee97e03218f4c5bd0c12f7d029677765245d3e9db10d0844eede6af107b1d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gitman-3.4.1b1-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.9.16 Darwin/22.5.0

File hashes

Hashes for gitman-3.4.1b1-py3-none-any.whl
Algorithm Hash digest
SHA256 866d17551e079c4f2f29375fffc44b4fd2d17bf61830a1b0f53d9b3d48867cd5
MD5 52aa60be73a1f588c7eb0ffc13ffbfbb
BLAKE2b-256 b9a61211a6c7ac5d64a8709b48bd64252c79a8d55b02f56b07cd188f06c1d87f

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