Metadata-Version: 2.1
Name: deploifai
Version: 0.3.3
Summary: Deploifai CLI
Home-page: https://github.com/deploifai/cli
Author: Deploifai Limited
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6, <3.10
Description-Content-Type: text/markdown

# Deploifai CLI

### Installation

```shell
pip install deploifai
```

### Usage

```shell
# ensure the cli is accessible
which deploifai
# show help message
deploifai --help
# show version
deploifai --version
```

## Contribute

### Setup Development Environment

Create python virtual environment:

```shell
python -m venv .venv
source .venv/bin/activate
````

Install dev dependencies:

```shell
pip install -U pip
pip install -r requirements.txt
```

Copy `sample.env` to `.env`:

```text
DEPLOIFAI_CLI_ENVIRONMENT=development
DEPLOIFAI_BACKEND_URL=http://localhost:4000
```

Run the deploifai cli script directly for testing:

```shell
python dev.py
```

Or, install `deploifai` cli tool in virtual environment for testing:

```shell
pip install --editable . 
```

Read the documentation of the `deploifai` cli tool in html:\
This documentation only functions on `Python>=3.7`.\
Installation of `mkdocs==1.3.1` and `mkdocs-click==0.8.0` required

```shell
mkdocs serve
```

