Metadata-Version: 2.1
Name: bugcatcher
Version: 0.0.8
Summary: Faster Than Light Command Line Test Client
Home-page: https://github.com/faster-than-light/bugcatcher
Author: Faster Than Light
Author-email: devops@fasterthanlight.dev
Maintainer: Faster Than Light
Maintainer-email: devops@fasterthanlight.dev
License: GNU GPL v2.0
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: colorama
Requires-Dist: pytest (>=3.5.0)

# ftl
Faster Than Light Command Line Test Client

### Installation

#### Installing with PIP
`pip install bugcatcher`

Installing with PIP creates a console script for `ftl` to run BugCatcher.

#### Installing from the GitHub Repository

Download or clone this repository to your drive. Then use PIP to install the local package by going to its directory in your console and typing: `pip install .`

### Usage

```
ftl [-h] [--project PROJECT] [--endpoint ENDPOINT] [--async]
       [--sid SID] [--extension EXTENSIONS]
       command [items [items ...]]
```

Retrieve a SID from the BugCatcher <a href="https://bugcatcher.fasterthanlight.dev" target="_blank">web app</a> and use it directly.

`ftl --project "Master" --sid 5EX3c6FNWMAv3AiIsFMGOhnMidNyDkarskyzddFq push *`

Or store some environmental variables.

```
export STL_INTERNAL_SID=5EX3c6FNWMAv3AiIsFMGOhnMidNyDkarskyzddFq
export FTL_PROJECT="Master"
```

Then minimize your `ftl` commands.

`ftl push *`

`ftl test`

`ftl view <test_id>`

`ftl del`

