git-development-cli-tools


Namegit-development-cli-tools JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://gitlab.com/RadianDevCore/tools/git-development-cli-tools
SummaryGit development CLI tools for daily usage
upload_time2025-01-01 17:40:29
maintainerNone
docs_urlNone
authorAdrian DC
requires_python!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3
licenseApache License 2.0
keywords git git-development-cli-tools
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # git-development-cli-tools

[![Release](https://img.shields.io/pypi/v/git-development-cli-tools?color=blue)](https://pypi.org/project/git-development-cli-tools)
[![Python](https://img.shields.io/pypi/pyversions/git-development-cli-tools?color=blue)](https://pypi.org/project/git-development-cli-tools)
[![Downloads](https://img.shields.io/pypi/dm/git-development-cli-tools?color=blue)](https://pypi.org/project/git-development-cli-tools)
[![License](https://img.shields.io/gitlab/license/RadianDevCore/tools/git-development-cli-tools?color=blue)](https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/-/blob/main/LICENSE)
<br />
[![Build](https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/badges/main/pipeline.svg)](https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/-/commits/main/)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=bugs)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=code_smells)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=coverage)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=ncloc)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)
<br />
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)

Git development CLI tools for daily usage

**Documentation:** <https://radiandevcore.gitlab.io/tools/git-development-cli-tools>  
**Package:** <https://pypi.org/project/git-development-cli-tools/>

---

<span class="page-break"></span>

## Usage

<!-- prettier-ignore-start -->
<!-- readme-help-start -->

```yaml
usage: git-development-cli-tools [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL]
                                 [--]

git-development-cli-tools: Git development CLI tools

internal arguments:
  -h, --help           # Show this help message
  --version            # Show the current version
  --no-color           # Disable colors outputs with 'NO_COLOR=1'
                       # (or default settings: [themes] > no_color)
  --update-check       # Check for newer package updates
  --settings           # Show the current settings path and contents
  --set GROUP KEY VAL  # Set settings specific 'VAL' value to [GROUP] > KEY
                       # or unset by using 'UNSET' as 'VAL'

positional arguments:
  --                   # Positional arguments separator (recommended)
```

<!-- readme-help-stop -->
<!-- prettier-ignore-end -->

---

<span class="page-break"></span>

## Userspace available settings

`git-development-cli-tools` creates a `settings.ini` configuration file in a userspace folder.

For example, it allows to disable the automated updates daily check (`[updates] > enabled`)

The `settings.ini` file location and contents can be shown with the following command:

```bash
git-development-cli-tools --settings
```

---

## Environment available configurations

`git-development-cli-tools` uses `colored` for colors outputs.

If colors of both outputs types do not match the terminal's theme,  
an environment variable `NO_COLOR=1` can be defined to disable colors.

---

<span class="page-break"></span>

## Dependencies

- [colored](https://pypi.org/project/colored/): Terminal colors and styles
- [setuptools](https://pypi.org/project/setuptools/): Build and manage Python packages
- [update-checker](https://pypi.org/project/update-checker/): Check for package updates on PyPI

---

## References

- [commitizen](https://pypi.org/project/commitizen/): Simple commit conventions for internet citizens
- [git-cliff](https://github.com/orhun/git-cliff): CHANGELOG generator
- [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab
- [gcil](https://radiandevcore.gitlab.io/tools/gcil): Launch .gitlab-ci.yml jobs locally
- [mkdocs](https://www.mkdocs.org/): Project documentation with Markdown
- [mkdocs-exporter](https://adrienbrignon.github.io/mkdocs-exporter/): Exporter plugin for mkdocs documentation
- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/): Material theme for mkdocs documentation
- [mypy](https://pypi.org/project/mypy/): Optional static typing for Python
- [pre-commit](https://pre-commit.com/): A framework for managing and maintaining pre-commit hooks
- [pre-commit-crocodile](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile): Git hooks intended for developers using pre-commit
- [PyPI](https://pypi.org/): The Python Package Index
- [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/RadianDevCore/tools/git-development-cli-tools",
    "name": "git-development-cli-tools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3",
    "maintainer_email": null,
    "keywords": "git git-development-cli-tools",
    "author": "Adrian DC",
    "author_email": "radian.dc@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/0b/3c/ee736d81255cf5e6e05e8c487d6892dd85bcce46c82318ed34ff72447dc8/git_development_cli_tools-0.1.0.tar.gz",
    "platform": null,
    "description": "# git-development-cli-tools\n\n[![Release](https://img.shields.io/pypi/v/git-development-cli-tools?color=blue)](https://pypi.org/project/git-development-cli-tools)\n[![Python](https://img.shields.io/pypi/pyversions/git-development-cli-tools?color=blue)](https://pypi.org/project/git-development-cli-tools)\n[![Downloads](https://img.shields.io/pypi/dm/git-development-cli-tools?color=blue)](https://pypi.org/project/git-development-cli-tools)\n[![License](https://img.shields.io/gitlab/license/RadianDevCore/tools/git-development-cli-tools?color=blue)](https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/-/blob/main/LICENSE)\n<br />\n[![Build](https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/badges/main/pipeline.svg)](https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/-/commits/main/)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=bugs)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=code_smells)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=coverage)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)\n[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=ncloc)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-development-cli-tools&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-development-cli-tools)\n<br />\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)\n[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)\n[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)\n\nGit development CLI tools for daily usage\n\n**Documentation:** <https://radiandevcore.gitlab.io/tools/git-development-cli-tools>  \n**Package:** <https://pypi.org/project/git-development-cli-tools/>\n\n---\n\n<span class=\"page-break\"></span>\n\n## Usage\n\n<!-- prettier-ignore-start -->\n<!-- readme-help-start -->\n\n```yaml\nusage: git-development-cli-tools [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL]\n                                 [--]\n\ngit-development-cli-tools: Git development CLI tools\n\ninternal arguments:\n  -h, --help           # Show this help message\n  --version            # Show the current version\n  --no-color           # Disable colors outputs with 'NO_COLOR=1'\n                       # (or default settings: [themes] > no_color)\n  --update-check       # Check for newer package updates\n  --settings           # Show the current settings path and contents\n  --set GROUP KEY VAL  # Set settings specific 'VAL' value to [GROUP] > KEY\n                       # or unset by using 'UNSET' as 'VAL'\n\npositional arguments:\n  --                   # Positional arguments separator (recommended)\n```\n\n<!-- readme-help-stop -->\n<!-- prettier-ignore-end -->\n\n---\n\n<span class=\"page-break\"></span>\n\n## Userspace available settings\n\n`git-development-cli-tools` creates a `settings.ini` configuration file in a userspace folder.\n\nFor example, it allows to disable the automated updates daily check (`[updates] > enabled`)\n\nThe `settings.ini` file location and contents can be shown with the following command:\n\n```bash\ngit-development-cli-tools --settings\n```\n\n---\n\n## Environment available configurations\n\n`git-development-cli-tools` uses `colored` for colors outputs.\n\nIf colors of both outputs types do not match the terminal's theme,  \nan environment variable `NO_COLOR=1` can be defined to disable colors.\n\n---\n\n<span class=\"page-break\"></span>\n\n## Dependencies\n\n- [colored](https://pypi.org/project/colored/): Terminal colors and styles\n- [setuptools](https://pypi.org/project/setuptools/): Build and manage Python packages\n- [update-checker](https://pypi.org/project/update-checker/): Check for package updates on PyPI\n\n---\n\n## References\n\n- [commitizen](https://pypi.org/project/commitizen/): Simple commit conventions for internet citizens\n- [git-cliff](https://github.com/orhun/git-cliff): CHANGELOG generator\n- [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab\n- [gcil](https://radiandevcore.gitlab.io/tools/gcil): Launch .gitlab-ci.yml jobs locally\n- [mkdocs](https://www.mkdocs.org/): Project documentation with Markdown\n- [mkdocs-exporter](https://adrienbrignon.github.io/mkdocs-exporter/): Exporter plugin for mkdocs documentation\n- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/): Material theme for mkdocs documentation\n- [mypy](https://pypi.org/project/mypy/): Optional static typing for Python\n- [pre-commit](https://pre-commit.com/): A framework for managing and maintaining pre-commit hooks\n- [pre-commit-crocodile](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile): Git hooks intended for developers using pre-commit\n- [PyPI](https://pypi.org/): The Python Package Index\n- [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "Git development CLI tools for daily usage",
    "version": "0.1.0",
    "project_urls": {
        "Bug Reports": "https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/-/issues",
        "Changelog": "https://gitlab.com/RadianDevCore/tools/git-development-cli-tools/blob/main/CHANGELOG.md",
        "Documentation": "https://gitlab.com/RadianDevCore/tools/git-development-cli-tools#git-development-cli-tools",
        "Homepage": "https://gitlab.com/RadianDevCore/tools/git-development-cli-tools",
        "Source": "https://gitlab.com/RadianDevCore/tools/git-development-cli-tools",
        "Statistics": "https://pypistats.org/packages/git-development-cli-tools"
    },
    "split_keywords": [
        "git",
        "git-development-cli-tools"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c3de2d01768ae42f3523d06c9980ef7e2e2f59b16f3bfc66750fe958e4b15007",
                "md5": "2e9be560b449229a5f6864cd2b224af1",
                "sha256": "1f3fe4d201988700c4340a20d197ce33ead0bb2ad20737537f2739581e15d029"
            },
            "downloads": -1,
            "filename": "git_development_cli_tools-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2e9be560b449229a5f6864cd2b224af1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3",
            "size": 20254,
            "upload_time": "2025-01-01T17:40:27",
            "upload_time_iso_8601": "2025-01-01T17:40:27.338167Z",
            "url": "https://files.pythonhosted.org/packages/c3/de/2d01768ae42f3523d06c9980ef7e2e2f59b16f3bfc66750fe958e4b15007/git_development_cli_tools-0.1.0-py3-none-any.whl",
            "yanked": true,
            "yanked_reason": "Pre-release version of RadianDevCore common tools sources"
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b3cee736d81255cf5e6e05e8c487d6892dd85bcce46c82318ed34ff72447dc8",
                "md5": "24e7431f18eab5342238e194fe2cbffe",
                "sha256": "b92b852f9713038e4a45ed0b35d484eb0fd5a3e914501621c661c957cbee8f4a"
            },
            "downloads": -1,
            "filename": "git_development_cli_tools-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "24e7431f18eab5342238e194fe2cbffe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3",
            "size": 48222,
            "upload_time": "2025-01-01T17:40:29",
            "upload_time_iso_8601": "2025-01-01T17:40:29.868057Z",
            "url": "https://files.pythonhosted.org/packages/0b/3c/ee736d81255cf5e6e05e8c487d6892dd85bcce46c82318ed34ff72447dc8/git_development_cli_tools-0.1.0.tar.gz",
            "yanked": true,
            "yanked_reason": "Pre-release version of RadianDevCore common tools sources"
        }
    ],
    "upload_time": "2025-01-01 17:40:29",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "RadianDevCore",
    "gitlab_project": "tools",
    "lcname": "git-development-cli-tools"
}
Adrian DC
Elapsed time: 0.78480s