Metadata-Version: 2.1
Name: dexterCLI
Version: 0.0.1
Summary: A command-line interface to the Dexter API
Author-email: Jon Ribbens <jribbens@unceasing.dev>
License: Copyright (c) 2022 Unceasing Digital Ltd
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Bug Tracker, https://github.com/unceasing.dev/dexterCLI/issues
Project-URL: Homepage, https://github.com/unceasing.dev/dexterCLI#README
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# dexter command-line interface

## Installation

    pip install dexterCLI

## Configuration

You can store settings in an INI-style configuration file, which by default
will be looked for in `~/.dexter.conf`. It can contained named sections,
each of which is a different configuration profile. The default profile is
called `default`. The two main keys needed are `root` and `api-key` which
respectively specify the root URL of the API interface, and the API key to
use.

Example:

    [default]
    root = https://api.dexter.express/
    api-key = 1234567812345678

## Usage

    usage: dexter [-h] [--api-key API_KEY] [--debug] [--output FILENAME]
                  [--profile PROFILE] [--quiet] [--rcfile RCFILE] [--root ROOT]
                  [--version]
                  {delete,cancel,fetch,list,queue,status,info,update} ...

    Dexter API command-line interface

    positional arguments:
      {delete,cancel,fetch,list,queue,status,info,update}

    optional arguments:
      -h, --help            show this help message and exit
      --api-key API_KEY     The API key to use
      --debug, -d           Display debug output
      --output FILENAME, -o FILENAME
                            The file to write the output to
      --profile PROFILE, -p PROFILE
                            The configuration profile to use (default: default)
      --quiet, -q           No output
      --rcfile RCFILE       The configuration file to load (default:
                            ~/.dexter.conf)
      --root ROOT           The root URL of the API interface
      --version, -V         Display the version number and exit

