Metadata-Version: 2.1
Name: projectalice-cli
Version: 1.3.18
Summary: Project Alice CLI tool
Home-page: https://github.com/project-alice-assistant/AliceCLI
Author: ProjectAlice
Author-email: laurentchervet@bluewin.ch
Maintainer: Psychokiller1888
License: GPL-3.0
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Installation/Setup
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: click (~=8.0.3)
Requires-Dist: paramiko (~=2.8.1)
Requires-Dist: InquirerPy (~=0.3.1)
Requires-Dist: networkscan (~=1.0.9)
Requires-Dist: pyyaml (~=6.0)
Requires-Dist: requests (~=2.26.0)
Requires-Dist: psutil (~=5.8.0)
Requires-Dist: beautifulsoup4 (~=4.10.0)
Requires-Dist: tqdm (~=4.62.3)
Requires-Dist: pytest (~=6.2.5)
Requires-Dist: coverage (~=6.2)
Requires-Dist: pytest-cov (~=3.0.0)
Requires-Dist: coveralls (~=3.3.1)
Requires-Dist: tomli (~=2.0.0)
Requires-Dist: six (~=1.16.0)

[![Upload Python Package](https://github.com/project-alice-assistant/AliceCLI/actions/workflows/python-publish.yml/badge.svg)](https://github.com/project-alice-assistant/AliceCLI/actions/workflows/python-publish.yml)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=project-alice-assistant_AliceCLI&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=project-alice-assistant_AliceCLI)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=project-alice-assistant_AliceCLI&metric=alert_status)](https://sonarcloud.io/dashboard?id=project-alice-assistant_AliceCLI)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=project-alice-assistant_AliceCLI&metric=coverage)](https://sonarcloud.io/dashboard?id=project-alice-assistant_AliceCLI) 

# Project Alice CLI

This is a Project Alice command line tool.

It simplifies to the maximum the installation and maintenance of Project Alice.

It is not meant to be installed on the device that runs/will run Alice, but on your main computer.

It handles connecting to network discoverable devices through SSH and generates RSA keys for a passwordless connection.

Although it's a command line tool, made possible thanks to the awesome "Click" package, it is using the wonderful "InquirerPy" package, a reboot of the deprecated "PyInquirer", to offer an interactive menu for people not used or wanting to type commands.

# Users
Install this tool via pip, on your main computer:

`pip3 install projectalice-cli`

Note that you need Python 3.8 at least


# Devs of this tool
- Clone this repository
- Open a terminal on whatever OS you are
- CD to the path where you cloned this repository
- Create a python 3.8+ virtual environment:
  `python -m venv`
- Activate your virtual environment
- Install the package in dev mode:
  `pip install --editable .`

# Usage
Type `alice` in your terminal to open the main menu or type `alice --help` to discover the available commands

# Useful information
This tool stores its configurations in `%USER_DIRECTORY%/.pacli`

This tool stores its generated SSH certificates in `%USER_DIRECTORY%/.ssh`

# Thank You!
jonah1024: A big thank you for making this work in macOs as well!

