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.
Setup
Requirements
- Python 3.8+
- Git 2.8+ (with stored credentials)
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:
- Create a working tree at
<root>/<location>/<name> - Fetch from
repoand checkout the specifiedrev - Symbolically link each
<location>/<name>from<root>/<link>(if specified) - Repeat for all nested working trees containing a config file
- Record the actual commit SHAs that were checked out (with
--lockoption) - 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-parsedate:'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
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
Built Distribution
File details
Details for the file gitman-3.5.1.tar.gz.
File metadata
- Download URL: gitman-3.5.1.tar.gz
- Upload date:
- Size: 32.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/23.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d3e3e85f20099224931d4730e53be925094bf31858d2c6ec943c5f353cbd905c |
|
| MD5 | 0f9fed2f935dbf909d5687543a0ca63c |
|
| BLAKE2b-256 | 7001ad4aa72c2ca190ffd7f5afef77ad747a0bb8d9890484fe976512b49fde9f |
File details
Details for the file gitman-3.5.1-py3-none-any.whl.
File metadata
- Download URL: gitman-3.5.1-py3-none-any.whl
- Upload date:
- Size: 40.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/23.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fd81302ebd038279a82671e52baa1dcc6c76a75faf772e686cc89a97fa1fdec0 |
|
| MD5 | 3aaec7c4b1682818b2c7c62880ee4b44 |
|
| BLAKE2b-256 | 0d980581142b620cab806165aed7000fb448e5404cf767f0e9de1bf48a451fbc |
