###########
consolekit
###########
.. start short_desc
.. documentation-summary::
:meta:
.. end short_desc
.. start shields
.. only:: html
.. 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| rtfd-shield::
:project: consolekit
:alt: Documentation Build Status
.. |docs_check| actions-shield::
:workflow: Docs Check
:alt: Docs Check Status
.. |actions_linux| actions-shield::
:workflow: Linux
:alt: Linux Test Status
.. |actions_windows| actions-shield::
:workflow: Windows
:alt: Windows Test Status
.. |actions_macos| actions-shield::
:workflow: macOS
:alt: macOS Test Status
.. |actions_flake8| actions-shield::
:workflow: Flake8
:alt: Flake8 Status
.. |actions_mypy| actions-shield::
:workflow: mypy
: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| coveralls-shield::
:alt: Coverage
.. |codefactor| codefactor-shield::
:alt: CodeFactor Grade
.. |pypi-version| pypi-shield::
:project: consolekit
:version:
:alt: PyPI - Package Version
.. |supported-versions| pypi-shield::
:project: consolekit
:py-versions:
:alt: PyPI - Supported Python Versions
.. |supported-implementations| pypi-shield::
:project: consolekit
:implementations:
:alt: PyPI - Supported Implementations
.. |wheel| pypi-shield::
:project: consolekit
:wheel:
: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| github-shield::
:license:
:alt: License
.. |language| github-shield::
:top-language:
:alt: GitHub top language
.. |commits-since| github-shield::
:commits-since: v1.7.0
:alt: GitHub commits since tagged version
.. |commits-latest| github-shield::
:last-commit:
:alt: GitHub last commit
.. |maintained| maintained-shield:: 2024
:alt: Maintenance
.. |pypi-downloads| pypi-shield::
:project: consolekit
:downloads: month
:alt: PyPI - Downloads
.. end shields
Installation
---------------
.. start installation
.. installation:: consolekit
:pypi:
:github:
:anaconda:
:conda-channels: conda-forge, domdfcoding
.. end installation
.. only:: latex
.. transition::
Additionally, for better support in terminals,
install `psutil `_ by specifying the ``terminals`` extra:
.. prompt:: bash
python -m pip install consolekit[terminals]
or, if you installed ``consolekit`` through conda:
.. prompt:: bash
conda install -c conda-forge psutil
Highlights
---------------
.. latex:vspace:: -20px
.. api-highlights::
:module: consolekit
:colours: blue,green,red,orange
.commands.MarkdownHelpCommand
.commands.SuggestionGroup
.input.choice
.options.auto_default_option
.. .options.flag_option
.. .tracebacks.TracebackHandler
.. .utils.coloured_diff
.. .utils.hidden_cursor
Contents
------------
.. html-section::
.. toctree::
:hidden:
Home
.. toctree::
:maxdepth: 3
:glob:
api/consolekit
api/*
.. only:: html
.. toctree::
:maxdepth: 3
:caption: Contributing
contributing
Source
license
.. sidebar-links::
:caption: Links
:github:
:pypi: consolekit
.. start links
.. only:: html
View the :ref:`Function Index ` or browse the `Source Code <_modules/index.html>`__.
:github:repo:`Browse the GitHub Repository `
.. end links