###########
consolekit
###########
.. start short_desc
**Additional utilities for click.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/consolekit/latest?logo=read-the-docs
:target: https://consolekit.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/consolekit/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/consolekit/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/consolekit/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/consolekit/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/consolekit/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/consolekit/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/consolekit/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/consolekit/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/consolekit/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/consolekit?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/consolekit?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/consolekit
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/consolekit
:target: https://pypi.org/project/consolekit/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/consolekit?logo=python&logoColor=white
:target: https://pypi.org/project/consolekit/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/consolekit
:target: https://pypi.org/project/consolekit/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/consolekit
:target: https://pypi.org/project/consolekit/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/consolekit?logo=anaconda
:target: https://anaconda.org/domdfcoding/consolekit
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/consolekit?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/consolekit
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/domdfcoding/consolekit
:target: https://github.com/domdfcoding/consolekit/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/consolekit
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/consolekit/v1.7.0
:target: https://github.com/domdfcoding/consolekit/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/consolekit
:target: https://github.com/domdfcoding/consolekit/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/consolekit
:target: https://pypi.org/project/consolekit/
:alt: PyPI - Downloads
.. end shields
Installation
--------------
.. start installation
``consolekit`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install consolekit
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install consolekit
.. end installation
Additionally, for better support in terminals,
install `psutil <https://pypi.org/project/psutil/>`_ by specifying the ``terminals`` extra:
.. code-block:: bash
$ python -m pip install consolekit[terminals]
or, if you installed ``consolekit`` through conda:
.. code-block:: bash
$ conda install -c conda-forge psutil
Raw data
{
"_id": null,
"home_page": null,
"name": "consolekit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6.1",
"maintainer_email": null,
"keywords": "click, terminal",
"author": null,
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/41/f0/ed6944829189ffad3de65617f0e2b4da3bb4577f2d6b2ce8399c24d794d5/consolekit-1.7.0.tar.gz",
"platform": null,
"description": "###########\nconsolekit\n###########\n\n.. start short_desc\n\n**Additional utilities for click.**\n\n.. end short_desc\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t - |conda-version| |conda-platform|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/consolekit/latest?logo=read-the-docs\n\t:target: https://consolekit.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/consolekit/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/domdfcoding/consolekit/workflows/Linux/badge.svg\n\t:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/consolekit/workflows/Windows/badge.svg\n\t:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/consolekit/workflows/macOS/badge.svg\n\t:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/domdfcoding/consolekit/workflows/Flake8/badge.svg\n\t:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/domdfcoding/consolekit/workflows/mypy/badge.svg\n\t:target: https://github.com/domdfcoding/consolekit/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/consolekit/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/consolekit/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/consolekit/master?logo=coveralls\n\t:target: https://coveralls.io/github/domdfcoding/consolekit?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/consolekit?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/consolekit\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/consolekit\n\t:target: https://pypi.org/project/consolekit/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/consolekit?logo=python&logoColor=white\n\t:target: https://pypi.org/project/consolekit/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/consolekit\n\t:target: https://pypi.org/project/consolekit/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/consolekit\n\t:target: https://pypi.org/project/consolekit/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/consolekit?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/consolekit\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/consolekit?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/consolekit\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/consolekit\n\t:target: https://github.com/domdfcoding/consolekit/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/consolekit\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/consolekit/v1.7.0\n\t:target: https://github.com/domdfcoding/consolekit/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/consolekit\n\t:target: https://github.com/domdfcoding/consolekit/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2024\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/consolekit\n\t:target: https://pypi.org/project/consolekit/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``consolekit`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install consolekit\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install consolekit\n\n.. end installation\n\nAdditionally, for better support in terminals,\ninstall `psutil <https://pypi.org/project/psutil/>`_ by specifying the ``terminals`` extra:\n\n.. code-block:: bash\n\n\t$ python -m pip install consolekit[terminals]\n\nor, if you installed ``consolekit`` through conda:\n\n.. code-block:: bash\n\n\t$ conda install -c conda-forge psutil\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Additional utilities for click.",
"version": "1.7.0",
"project_urls": {
"Documentation": "https://consolekit.readthedocs.io/en/latest",
"Homepage": "https://github.com/domdfcoding/consolekit",
"Issue Tracker": "https://github.com/domdfcoding/consolekit/issues",
"Source Code": "https://github.com/domdfcoding/consolekit"
},
"split_keywords": [
"click",
" terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57fc16e6aea553ebf263ae2d7806e5511700edd5db48f79cf487b115a7808169",
"md5": "8371497c54cfc9836d32d0b0e3a41520",
"sha256": "064e32c520d63443ac47da7b2d4010c5646c1c78c9b1649adb9dd5d27116cb05"
},
"downloads": -1,
"filename": "consolekit-1.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8371497c54cfc9836d32d0b0e3a41520",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.1",
"size": 44269,
"upload_time": "2024-03-20T11:38:00",
"upload_time_iso_8601": "2024-03-20T11:38:00.551090Z",
"url": "https://files.pythonhosted.org/packages/57/fc/16e6aea553ebf263ae2d7806e5511700edd5db48f79cf487b115a7808169/consolekit-1.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41f0ed6944829189ffad3de65617f0e2b4da3bb4577f2d6b2ce8399c24d794d5",
"md5": "dd21ddd7f6aeade8901589b89d86ad0b",
"sha256": "0ea8bce2a7941a2af0e33d5acb76eeacb78711278d2b60c33ed3e7a49cc3fd0c"
},
"downloads": -1,
"filename": "consolekit-1.7.0.tar.gz",
"has_sig": false,
"md5_digest": "dd21ddd7f6aeade8901589b89d86ad0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.1",
"size": 30484,
"upload_time": "2024-03-20T11:38:02",
"upload_time_iso_8601": "2024-03-20T11:38:02.355480Z",
"url": "https://files.pythonhosted.org/packages/41/f0/ed6944829189ffad3de65617f0e2b4da3bb4577f2d6b2ce8399c24d794d5/consolekit-1.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 11:38:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "domdfcoding",
"github_project": "consolekit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
">=",
"7.1.2"
]
]
},
{
"name": "colorama",
"specs": [
[
">=",
"0.4.3"
]
]
},
{
"name": "deprecation-alias",
"specs": [
[
">=",
"0.1.1"
]
]
},
{
"name": "domdf-python-tools",
"specs": [
[
">=",
"3.8.0"
]
]
},
{
"name": "mistletoe",
"specs": [
[
">=",
"0.7.2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"3.10.0.0"
],
[
"!=",
"3.10.0.1"
]
]
}
],
"tox": true,
"lcname": "consolekit"
}