Metadata-Version: 2.1
Name: chatfaq_cli
Version: 0.1.9
Summary: 
Author: Hector Soria
Author-email: hector.soria@with-madrid.com
Requires-Python: >=3,<4
Classifier: Programming Language :: Python :: 3
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 :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: crochet (>=2.1.1,<3.0.0)
Requires-Dist: fire (>=0.5.0,<0.6.0)
Requires-Dist: requests (>=2.30.0,<3.0.0)
Requires-Dist: tqdm (>=4.65.0,<5.0.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# ChatFAQ Command Line Interface (CLI) Tool

The full potential of ChatFAQ services, datasets, and models at the tip of your fingers.

## Prerequisites

Make sure the next list of packages are installed on your system:

- Python 3.10
- poetry

## Installation

### Local build

`poetry install`

### PYPI

`pip install chatfaq-cli`

## Usage

First of all you should configure the remote target server:

`chatfaq config host <REMOTE_ADRESS>`

Then you can log in into the remote server:

`chatfaq config auth <TOKEN>`

You can retrieve the auth token from the backend server:

`curl -X POST -u username:password http://localhost:8000/back/api/login/`

by using an admin's user and password.

## Commands

`chatfaq --help`

### Publish package

#### PYPI test

add repository to poetry config

    poetry config repositories.chatfaq-cli https://test.pypi.org/legacy/

get token from https://test.pypi.org/manage/account/token/

store token using

    poetry config pypi-token.chatfaq-cli pypi-YYYYYYYY

#### PYPI production

get token from https://pypi.org/manage/account/token/

store token using

    poetry config pypi-token.chatfaq-cli pypi-XXXXXXXX

Each time you need to publish

Bump version

    poetry version prerelease

or

    poetry version patch

#### Poetry Build

    poetry build

#### Poetry Publish

To TestPyPi

    poetry publish -r chatfaq-cli

To PyPi

    poetry publish

