Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .tool-versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
python 3.9.18
poetry 2.1.4
poetry 2.2.1
nodejs 20.11.0
2 changes: 1 addition & 1 deletion docs/interfaces/cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Command-line Interface

After setting up `gitman` with a [config file](../index.md#setup), various commands can be run to manage these Git-controlled source dependencies.
After setting up Gitman with a [config file](../index.md#setup), various commands can be run to manage these Git-controlled source dependencies.

## Init

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Git Plugin

`gitman` offers a simplified version of the [command-line interface](cli.md) in the form of a plugin for Git.
Gitman offers a simplified version of the [command-line interface](cli.md) in the form of a plugin for Git.

## Install

Expand Down
55 changes: 30 additions & 25 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
altgraph==0.17.2 ; python_version >= "3.9" and python_version < "3.15"
astroid==3.3.11 ; python_version >= "3.9" and python_version < "3.15"
black==25.1.0 ; python_version >= "3.9" and python_version < "3.15"
black==25.9.0 ; python_version >= "3.9" and python_version < "3.15"
cached-property==1.5.2 ; python_version >= "3.9" and python_version < "3.15"
certifi==2024.7.4 ; python_version >= "3.9" and python_version < "3.15"
charset-normalizer==2.1.1 ; python_version >= "3.9" and python_version < "3.15"
Expand All @@ -9,63 +9,68 @@ click==8.1.3 ; python_version >= "3.9" and python_version < "3.15"
colorama==0.4.5 ; python_version >= "3.9" and python_version < "3.15"
coverage==7.10.6 ; python_version >= "3.9" and python_version < "3.15"
coveragespace==6.1 ; python_version >= "3.9" and python_version < "3.15"
datafiles==2.3.1 ; python_version >= "3.9" and python_version < "3.15"
datafiles==2.3.4 ; python_version >= "3.9" and python_version < "3.15"
dill==0.3.8 ; python_version >= "3.9" and python_version < "3.15"
docopt==0.6.2 ; python_version >= "3.9" and python_version < "3.15"
exceptiongroup==1.1.1 ; python_version >= "3.9" and python_version < "3.11"
freezegun==1.5.5 ; python_version >= "3.9" and python_version < "3.15"
future==0.18.3 ; python_version >= "3.9" and python_version < "3.15" and sys_platform == "win32"
ghp-import==2.1.0 ; python_version >= "3.9" and python_version < "3.15"
griffe==1.14.0 ; python_version >= "3.9" and python_version < "3.11"
griffe==1.15.0 ; python_version >= "3.11" and python_version < "3.15"
idna==3.3 ; python_version >= "3.9" and python_version < "3.15"
importlib-metadata==4.12.0 ; python_version >= "3.9" and python_version < "3.15"
importlib-metadata==4.12.0 ; python_version == "3.9"
iniconfig==1.1.1 ; python_version >= "3.9" and python_version < "3.15"
isort==6.0.1 ; python_version >= "3.9" and python_version < "3.15"
isort==6.1.0 ; python_version >= "3.9" and python_version < "3.15"
jinja2==3.1.6 ; python_version >= "3.9" and python_version < "3.15"
json-five==1.1.2 ; python_version >= "3.9" and python_version < "3.15"
librt==0.6.3 ; python_version >= "3.9" and python_version < "3.15" and platform_python_implementation != "PyPy"
macfsevents==0.8.4 ; python_version >= "3.9" and python_version < "3.15" and sys_platform == "darwin"
macholib==1.16 ; python_version >= "3.9" and python_version < "3.15" and sys_platform == "darwin"
markdown==3.3.7 ; python_version >= "3.9" and python_version < "3.15"
markdown==3.9 ; python_version >= "3.9" and python_version < "3.15"
markupsafe==2.1.1 ; python_version >= "3.9" and python_version < "3.15"
mccabe==0.6.1 ; python_version >= "3.9" and python_version < "3.15"
mergedeep==1.3.4 ; python_version >= "3.9" and python_version < "3.15"
minilog==2.3.1 ; python_version >= "3.9" and python_version < "3.15"
mkdocs-autorefs==0.4.1 ; python_version >= "3.9" and python_version < "3.15"
mkdocs==1.3.1 ; python_version >= "3.9" and python_version < "3.15"
mkdocstrings-python-legacy==0.2.2 ; python_version >= "3.9" and python_version < "3.15"
mkdocstrings==0.18.1 ; python_version >= "3.9" and python_version < "3.15"
mkdocs-autorefs==1.4.3 ; python_version >= "3.9" and python_version < "3.15"
mkdocs-get-deps==0.2.0 ; python_version >= "3.9" and python_version < "3.15"
mkdocs==1.6.1 ; python_version >= "3.9" and python_version < "3.15"
mkdocstrings-python==1.18.2 ; python_version >= "3.9" and python_version < "3.11"
mkdocstrings-python==2.0.1 ; python_version >= "3.11" and python_version < "3.15"
mkdocstrings==0.30.1 ; python_version >= "3.9" and python_version < "3.15"
mypy-extensions==1.0.0 ; python_version >= "3.9" and python_version < "3.15"
mypy==1.3.0 ; python_version >= "3.9" and python_version < "3.15"
mypy==1.19.1 ; python_version >= "3.9" and python_version < "3.15"
nose==1.3.7 ; python_version >= "3.9" and python_version < "3.15"
packaging==24.1 ; python_version >= "3.9" and python_version < "3.15"
parse==1.19.0 ; python_version >= "3.9" and python_version < "3.15"
pathspec==0.10.1 ; python_version >= "3.9" and python_version < "3.15"
pathspec==0.12.1 ; python_version >= "3.9" and python_version < "3.15"
pefile==2022.5.30 ; python_version >= "3.9" and python_version < "3.15" and sys_platform == "win32"
platformdirs==2.5.2 ; python_version >= "3.9" and python_version < "3.15"
pluggy==1.5.0 ; python_version >= "3.9" and python_version < "3.15"
pydocstyle==6.1.1 ; python_version >= "3.9" and python_version < "3.15"
pygments==2.15.0 ; python_version >= "3.9" and python_version < "3.15"
pyinstaller-hooks-contrib==2025.8 ; python_version >= "3.9" and python_version < "3.15"
pyinstaller==6.15.0 ; python_version >= "3.9" and python_version < "3.15"
pylint==3.3.8 ; python_version >= "3.9" and python_version < "3.15"
pydocstyle==6.3.0 ; python_version >= "3.9" and python_version < "3.15"
pygments==2.19.2 ; python_version >= "3.9" and python_version < "3.15"
pyinstaller-hooks-contrib==2025.10 ; python_version >= "3.9" and python_version < "3.15"
pyinstaller==6.17.0 ; python_version >= "3.9" and python_version < "3.15"
pylint==3.3.9 ; python_version >= "3.9" and python_version < "3.15"
pymdown-extensions==10.0 ; python_version >= "3.9" and python_version < "3.15"
pync==2.0.3 ; python_version >= "3.9" and python_version < "3.15" and sys_platform == "darwin"
pytest-cov==7.0.0 ; python_version >= "3.9" and python_version < "3.15"
pytest-describe==2.2.0 ; python_version >= "3.9" and python_version < "3.15"
pytest-describe==3.1.0 ; python_version >= "3.9" and python_version < "3.15"
pytest-expecter==3.0 ; python_version >= "3.9" and python_version < "3.15"
pytest-random==0.02 ; python_version >= "3.9" and python_version < "3.15"
pytest==8.3.2 ; python_version >= "3.9" and python_version < "3.15"
pytest==8.4.2 ; python_version >= "3.9" and python_version < "3.15"
python-dateutil==2.8.2 ; python_version >= "3.9" and python_version < "3.15"
python-termstyle==0.1.10 ; python_version >= "3.9" and python_version < "3.15"
pytkdocs==0.16.1 ; python_version >= "3.9" and python_version < "3.15"
pytokens==0.1.10 ; python_version >= "3.9" and python_version < "3.15"
pytoolconfig==1.3.0 ; python_version >= "3.9" and python_version < "3.15"
pywin32-ctypes==0.2.3 ; python_version >= "3.9" and python_version < "3.15" and sys_platform == "win32"
pyyaml-env-tag==0.1 ; python_version >= "3.9" and python_version < "3.15"
pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "3.15"
regex==2025.9.1 ; python_version >= "3.9" and python_version < "3.15"
requests==2.32.5 ; python_version >= "3.9" and python_version < "3.15"
rope==1.14.0 ; python_version >= "3.9" and python_version < "3.15"
ruamel-yaml-clib==0.2.8 ; python_version >= "3.9" and python_version < "3.11" and platform_python_implementation == "CPython"
ruamel-yaml==0.17.21 ; python_version >= "3.9" and python_version < "3.15"
ruamel-yaml-clib==0.2.14 ; python_version >= "3.9" and python_version < "3.14" and platform_python_implementation == "CPython"
ruamel-yaml==0.18.15 ; python_version >= "3.9" and python_version < "3.15"
setuptools==80.9.0 ; python_version >= "3.9" and python_version < "3.15"
six==1.16.0 ; python_version >= "3.9" and python_version < "3.15"
sly==0.5 ; python_version >= "3.9" and python_version < "3.15"
Expand All @@ -74,9 +79,9 @@ snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.15"
tomli==2.0.1 ; python_version >= "3.9" and python_version < "3.11"
tomlkit==0.10.2 ; python_version >= "3.9" and python_version < "3.15"
types-freezegun==1.1.10 ; python_version >= "3.9" and python_version < "3.15"
types-setuptools==65.3.0 ; python_version >= "3.9" and python_version < "3.15"
typing-extensions==4.3.0 ; python_version >= "3.9" and python_version < "3.15"
universal-startfile==0.2 ; python_version >= "3.9" and python_version < "3.15"
types-setuptools==80.9.0.20251223 ; python_version >= "3.9" and python_version < "3.15"
typing-extensions==4.15.0 ; python_version >= "3.9" and python_version < "3.15"
universal-startfile==0.4 ; python_version >= "3.9" and python_version < "3.15"
urllib3==2.6.3 ; python_version >= "3.9" and python_version < "3.15"
watchdog==2.1.9 ; python_version >= "3.9" and python_version < "3.15"
zipp==3.19.1 ; python_version >= "3.9" and python_version < "3.15"
zipp==3.19.1 ; python_version == "3.9"
4 changes: 2 additions & 2 deletions docs/setup/git-svn.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Git SVN Setup

If you're planning to use `gitman` to manage Subversion repositories, ensure `git svn` is configured correctly.
If you're planning to use Gitman to manage Subversion repositories, ensure `git svn` is configured correctly.

## Install missing SVN packages

Expand All @@ -11,7 +11,7 @@ sudo apt-get install subversion libapache2-svn

## Credentials

In order for `gitman` to interact with `git svn`, it must be configured to store your SVN credentials (cached) for private repository access. As a test, trying cloning one of your private repositories:
In order for Gitman to interact with `git svn`, it must be configured to store your SVN credentials (cached) for private repository access. As a test, trying cloning one of your private repositories:

```sh
$ git svn clone -r <rev> <repo>
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/git.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Git Setup

In order for `gitman` to interact with Git, it must be configured to store your credentials for private repository access.
In order for Gitman to interact with Git, it must be configured to store your credentials for private repository access.

To test, trying cloning one of your private repositories:

Expand Down
2 changes: 1 addition & 1 deletion docs/use-cases/branch-tracking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tracking Branches in Dependencies

One common use case of `gitman` is to track versions of related product sub-components such as a web app that depends on an API.
One common use case of Gitman is to track versions of related product sub-components such as a web app that depends on an API.

## Sample Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/use-cases/build-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Gitman can be invoked from your build system or continuous integration environme

## Makefile

The following example shows one way you might want to call `gitman` from within a Makefile:
The following example shows one way you might want to call Gitman from within a Makefile:

```makefile
.PHONY: all
Expand Down
2 changes: 1 addition & 1 deletion docs/use-cases/linked-features.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Linking Related Feature Branches


Another use case of `gitman` is to test experimental versions of related product sub-components. In the [web app + API example](branch-tracking.md), a new feature might require changes in both the API and web app.
Another use case of Gitman is to test experimental versions of related product sub-components. In the [web app + API example](branch-tracking.md), a new feature might require changes in both the API and web app.

## Custom Locked Sources

Expand Down
2 changes: 1 addition & 1 deletion docs/use-cases/submodules.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Using Git in the outer working tree will essentially ignore the contents of the

## Mimicking Submodules

To get the same behavior using `gitman`, first delete the `.gitmodules` file and create a new `.gitman.yml`:
To get the same behavior using Gitman, first delete the `.gitmodules` file and create a new `.gitman.yml`:

```yaml
location: .gitman
Expand Down
76 changes: 73 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ coveragespace = "^6.1"
# Documentation
mkdocs = "^1.2.3"
mkdocstrings = ">=0.18.1,<0.31.0"
mkdocstrings-python = "*"
pygments = "^2.15.0"
jinja2 = "~3.1.6"

Expand Down