Metadata-Version: 2.4
Name: pyformica
Version: 0.1.9
Summary: Netwotk automation tool
Author-email: minhtt15 <thanhminh20002005@gmail.com>
Requires-Python: >=3.12
Requires-Dist: aiohttp>=3.11.18
Requires-Dist: aiosqlite>=0.21.0
Requires-Dist: alembic>=1.15.1
Requires-Dist: asyncssh>=2.20.0
Requires-Dist: celery>=5.4.0
Requires-Dist: fastapi-cli>=0.0.7
Requires-Dist: fastapi-users[sqlalchemy]>=14.0.1
Requires-Dist: fastapi>=0.115.11
Requires-Dist: jinja2>=3.1.6
Requires-Dist: jose>=1.0.0
Requires-Dist: parallel-ssh>=2.14.0
Requires-Dist: paramiko>=3.5.1
Requires-Dist: passlib>=1.7.4
Requires-Dist: pyjwt>=2.10.1
Requires-Dist: python-jose>=3.4.0
Requires-Dist: python-multipart>=0.0.20
Requires-Dist: sqlmodel>=0.0.23
Requires-Dist: telnetlib3>=2.0.4
Requires-Dist: typer>=0.15.2
Requires-Dist: uvicorn>=0.34.0
Description-Content-Type: text/markdown

# Formica

A low-code automation tool for network configuration

## Requirements

- Python 3.12 

## Usage

### 1. Initialize the metadata folder

The default path for the metadata folder is `~/formica`. You can change it by setting the `FORMICA_HOME` environment variable.
To initialize the metadata folder, run:

```bash
formica init
```

The metadata folder will be created at the specified path, and it will contain the following files:
- `formica.ini`: Configuration file for Formica.
- `logs/`: Directory for logs.
- `logging_config.json`: Logging configuration file.

You should check the `formica.ini` file to configure before running.

### 2. Run Formica

To run all 3 components of Formica (Webserver, Scheduler and Executor), use this command:

```bash
formica standalone
```

Formica will be available at `http://localhost:8000`. (with default `HOST` and `PORT`)
