Metadata-Version: 2.1
Name: craft-cli
Version: 0.3.1
Summary: "Command Line Interface"
Home-page: https://github.com/canonical/craft-cli
Author: Canonical Ltd.
Author-email: snapcraft@lists.snapcraft.io
License: GNU Lesser General Public License v3 (LGPLv3)
Project-URL: Documentation, https://craft-cli.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/canonical/craft-cli.git
Project-URL: Issues, https://github.com/canonical/craft-cli/issues
Description: # Craft CLI
        
        A Command Line Client builder that follows the [Canonical's Guidelines for a Command Line
        Interface](https://discourse.ubuntu.com/c/design/cli-guidelines/62).
        
        The library provides two main functionalities: 
        
        - a framework to define and execute application commands, which involves argument parsing and the provision of help texts
        
        - infrastructure to handle the terminal and present all the outputs for the different application needs
        
        
        # Documentation
        
        The [documentation](https://craft-cli.readthedocs.io) is available on Read The Docs.
        
        
        # Setting up the environment
        
        Install at system level:
        
            sudo snap install pyright
        
        Create a virtual environment, activate it, and install developer dependencies:
        
            python3 -m venv env
            source env/bin/activate
            pip install .[dev]
        
        That's all.
        
        
        # Contributing
        
        A `Makefile` is provided for easy interaction with the project. To see
        all available options run:
        
            make help
        
        
        ## Running tests
        
        To run all tests in the suite run:
        
            make tests
        
        
        ## Verifying documentation changes
        
        To locally verify documentation changes run:
        
            make docs
        
        After running, newly generated documentation shall be available at
        `./docs/_build/html/`.
        
        
        # License
        
        Free software: GNU Lesser General Public License v3
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: release
Provides-Extra: test
