bolton-clack


Namebolton-clack JSON
Version 0.3.12 PyPI version JSON
download
home_pagehttps://github.com/python-boltons/clack
Summarycommand-line application configuration kit (CLACK)... A wrapper around the `argparse` library that aims to handle _all_ application configuration.
upload_time2024-04-06 03:33:51
maintainerNone
docs_urlNone
authorBryan M Bugyi
requires_python>=3.9
licenseMIT license
keywords
VCS
bugtrack_url
requirements annotated-types bolton-eris bolton-ion bolton-logrus bolton-metaman bolton-typist pydantic pydantic-core pydantic-settings python-dotenv pyyaml structlog typing-extensions
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # clack

**command-line application configuration kit (CLACK)... A wrapper around the `argparse` library that aims to handle _all_ application configuration.**

_project status badges:_

[![CI Workflow](https://github.com/python-boltons/clack/actions/workflows/ci.yml/badge.svg)](https://github.com/python-boltons/clack/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/python-boltons/clack/branch/master/graph/badge.svg)](https://codecov.io/gh/python-boltons/clack)
[![Documentation Status](https://readthedocs.org/projects/bolton-clack/badge/?version=latest)](https://bolton-clack.readthedocs.io/en/latest/?badge=latest)
[![Package Health](https://snyk.io/advisor/python/bolton-clack/badge.svg)](https://snyk.io/advisor/python/bolton-clack)

_version badges:_

[![Project Version](https://img.shields.io/pypi/v/bolton-clack)](https://pypi.org/project/bolton-clack/)
[![Python Versions](https://img.shields.io/pypi/pyversions/bolton-clack)](https://pypi.org/project/bolton-clack/)
[![Cookiecutter: cc-python](https://img.shields.io/static/v1?label=cc-python&message=2024.01.16-4&color=d4aa00&logo=cookiecutter&logoColor=d4aa00)](https://github.com/python-boltons/cc-python)
[![Docker: pythonboltons/main](https://img.shields.io/static/v1?label=pythonboltons%20%2F%20main&message=2024.01.16&color=8ec4ad&logo=docker&logoColor=8ec4ad)](https://github.com/python-boltons/docker-python)


## Installation 🗹

To install `clack` using [pip][9], run the following
commands in your terminal:

``` shell
python3 -m pip install --user bolton-clack  # install clack
```

If you don't have pip installed, this [Python installation guide][10] can guide
you through the process.

<!-- [[[[[kooky.cog
from pathlib import Path

lines = Path("./docs/design/design.md").read_text().split("\n")
if any(L.strip() for L in lines):
    fixed_lines = [L.replace("(.", "(./docs/design") if L.startswith("![") else L for L in lines]
    print("## Design Diagrams\n")
    print("\n".join(fixed_lines))
]]]]] -->
<!-- [[[[[end]]]]] -->


## Useful Links 🔗

* [API Reference][3]: A developer's reference of the API exposed by this
  project.
* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.
  Changes made to this cookiecutter are periodically synced with this project
  using [cruft][12].
* [CHANGELOG.md][2]: We use this file to document all notable changes made to
  this project.
* [CONTRIBUTING.md][7]: This document contains guidelines for developers
  interested in contributing to this project.
* [Create a New Issue][13]: Create a new GitHub issue for this project.
* [Documentation][1]: This project's full documentation.


[1]: https://bolton-clack.readthedocs.io/en/latest
[2]: https://github.com/python-boltons/clack/blob/master/CHANGELOG.md
[3]: https://bolton-clack.readthedocs.io/en/latest/modules.html
[4]: https://github.com/python-boltons/cc-python
[5]: https://github.com/cookiecutter/cookiecutter
[6]: https://docs.readthedocs.io/en/stable/
[7]: https://github.com/python-boltons/clack/blob/master/CONTRIBUTING.md
[8]: https://github.com/python-boltons/clack
[9]: https://pip.pypa.io
[10]: http://docs.python-guide.org/en/latest/starting/installation/
[11]: https://github.com/pypa/pipx
[12]: https://github.com/cruft/cruft
[13]: https://github.com/python-boltons/clack/issues/new/choose
[14]: https://pypi.org/project/cogapp/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/python-boltons/clack",
    "name": "bolton-clack",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Bryan M Bugyi",
    "author_email": "bryanbugyi34@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bc/23/3949000223c66fd09213bf4deda6da55e80bf54f0ddccd875b8664a3b66a/bolton-clack-0.3.12.tar.gz",
    "platform": null,
    "description": "# clack\n\n**command-line application configuration kit (CLACK)... A wrapper around the `argparse` library that aims to handle _all_ application configuration.**\n\n_project status badges:_\n\n[![CI Workflow](https://github.com/python-boltons/clack/actions/workflows/ci.yml/badge.svg)](https://github.com/python-boltons/clack/actions/workflows/ci.yml)\n[![Coverage](https://codecov.io/gh/python-boltons/clack/branch/master/graph/badge.svg)](https://codecov.io/gh/python-boltons/clack)\n[![Documentation Status](https://readthedocs.org/projects/bolton-clack/badge/?version=latest)](https://bolton-clack.readthedocs.io/en/latest/?badge=latest)\n[![Package Health](https://snyk.io/advisor/python/bolton-clack/badge.svg)](https://snyk.io/advisor/python/bolton-clack)\n\n_version badges:_\n\n[![Project Version](https://img.shields.io/pypi/v/bolton-clack)](https://pypi.org/project/bolton-clack/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/bolton-clack)](https://pypi.org/project/bolton-clack/)\n[![Cookiecutter: cc-python](https://img.shields.io/static/v1?label=cc-python&message=2024.01.16-4&color=d4aa00&logo=cookiecutter&logoColor=d4aa00)](https://github.com/python-boltons/cc-python)\n[![Docker: pythonboltons/main](https://img.shields.io/static/v1?label=pythonboltons%20%2F%20main&message=2024.01.16&color=8ec4ad&logo=docker&logoColor=8ec4ad)](https://github.com/python-boltons/docker-python)\n\n\n## Installation \ud83d\uddf9\n\nTo install `clack` using [pip][9], run the following\ncommands in your terminal:\n\n``` shell\npython3 -m pip install --user bolton-clack  # install clack\n```\n\nIf you don't have pip installed, this [Python installation guide][10] can guide\nyou through the process.\n\n<!-- [[[[[kooky.cog\nfrom pathlib import Path\n\nlines = Path(\"./docs/design/design.md\").read_text().split(\"\\n\")\nif any(L.strip() for L in lines):\n    fixed_lines = [L.replace(\"(.\", \"(./docs/design\") if L.startswith(\"![\") else L for L in lines]\n    print(\"## Design Diagrams\\n\")\n    print(\"\\n\".join(fixed_lines))\n]]]]] -->\n<!-- [[[[[end]]]]] -->\n\n\n## Useful Links \ud83d\udd17\n\n* [API Reference][3]: A developer's reference of the API exposed by this\n  project.\n* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.\n  Changes made to this cookiecutter are periodically synced with this project\n  using [cruft][12].\n* [CHANGELOG.md][2]: We use this file to document all notable changes made to\n  this project.\n* [CONTRIBUTING.md][7]: This document contains guidelines for developers\n  interested in contributing to this project.\n* [Create a New Issue][13]: Create a new GitHub issue for this project.\n* [Documentation][1]: This project's full documentation.\n\n\n[1]: https://bolton-clack.readthedocs.io/en/latest\n[2]: https://github.com/python-boltons/clack/blob/master/CHANGELOG.md\n[3]: https://bolton-clack.readthedocs.io/en/latest/modules.html\n[4]: https://github.com/python-boltons/cc-python\n[5]: https://github.com/cookiecutter/cookiecutter\n[6]: https://docs.readthedocs.io/en/stable/\n[7]: https://github.com/python-boltons/clack/blob/master/CONTRIBUTING.md\n[8]: https://github.com/python-boltons/clack\n[9]: https://pip.pypa.io\n[10]: http://docs.python-guide.org/en/latest/starting/installation/\n[11]: https://github.com/pypa/pipx\n[12]: https://github.com/cruft/cruft\n[13]: https://github.com/python-boltons/clack/issues/new/choose\n[14]: https://pypi.org/project/cogapp/\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "command-line application configuration kit (CLACK)... A wrapper around the `argparse` library that aims to handle _all_ application configuration.",
    "version": "0.3.12",
    "project_urls": {
        "Homepage": "https://github.com/python-boltons/clack"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "db8f38f2920d0d445440dd2e746d644d44445000d6e93720562ca0f9e664eb75",
                "md5": "256b7e1e2c63905695f4ead7c679cddc",
                "sha256": "fed39c34291a449ae75b1b36b1e8ba064bf3cfd84e781d7100b7584927711252"
            },
            "downloads": -1,
            "filename": "bolton_clack-0.3.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "256b7e1e2c63905695f4ead7c679cddc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 19342,
            "upload_time": "2024-04-06T03:33:49",
            "upload_time_iso_8601": "2024-04-06T03:33:49.978460Z",
            "url": "https://files.pythonhosted.org/packages/db/8f/38f2920d0d445440dd2e746d644d44445000d6e93720562ca0f9e664eb75/bolton_clack-0.3.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bc233949000223c66fd09213bf4deda6da55e80bf54f0ddccd875b8664a3b66a",
                "md5": "1fe7da1fd0f386ab8f70779aeb767c66",
                "sha256": "0b59eda34f7008521cd9a37b797ede783f048b1d0bec1c351f27b3f46434e056"
            },
            "downloads": -1,
            "filename": "bolton-clack-0.3.12.tar.gz",
            "has_sig": false,
            "md5_digest": "1fe7da1fd0f386ab8f70779aeb767c66",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 52466,
            "upload_time": "2024-04-06T03:33:51",
            "upload_time_iso_8601": "2024-04-06T03:33:51.770888Z",
            "url": "https://files.pythonhosted.org/packages/bc/23/3949000223c66fd09213bf4deda6da55e80bf54f0ddccd875b8664a3b66a/bolton-clack-0.3.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-06 03:33:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "python-boltons",
    "github_project": "clack",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "annotated-types",
            "specs": [
                [
                    "==",
                    "0.6.0"
                ]
            ]
        },
        {
            "name": "bolton-eris",
            "specs": [
                [
                    "==",
                    "0.2.3"
                ]
            ]
        },
        {
            "name": "bolton-ion",
            "specs": [
                [
                    "==",
                    "0.1.0"
                ]
            ]
        },
        {
            "name": "bolton-logrus",
            "specs": [
                [
                    "==",
                    "0.1.3"
                ]
            ]
        },
        {
            "name": "bolton-metaman",
            "specs": [
                [
                    "==",
                    "0.1.2"
                ]
            ]
        },
        {
            "name": "bolton-typist",
            "specs": [
                [
                    "==",
                    "0.2.0"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    "==",
                    "2.6.4"
                ]
            ]
        },
        {
            "name": "pydantic-core",
            "specs": [
                [
                    "==",
                    "2.16.3"
                ]
            ]
        },
        {
            "name": "pydantic-settings",
            "specs": [
                [
                    "==",
                    "2.2.1"
                ]
            ]
        },
        {
            "name": "python-dotenv",
            "specs": [
                [
                    "==",
                    "1.0.1"
                ]
            ]
        },
        {
            "name": "pyyaml",
            "specs": [
                [
                    "==",
                    "6.0.1"
                ]
            ]
        },
        {
            "name": "structlog",
            "specs": [
                [
                    "==",
                    "24.1.0"
                ]
            ]
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    "==",
                    "4.10.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "bolton-clack"
}
        
Elapsed time: 0.86077s