Metadata-Version: 2.1
Name: seroup
Version: 0.2.6
Summary: CLI tool to manage sero servers
Author: clowzed
Author-email: clowzed.work@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: dacite (>=1.8.1,<2.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: seroapi (>=0.2.6,<0.3.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Description-Content-Type: text/markdown

# Seroup

Seroup is a CLI management tool for [sero](https://github.com/clowzed/sero) servers, allowing you to easily upload and manage site on this server.
The last version of this tool is guaranteed to work with latest stable release of sero server.

## Table of Contents

- [Seroup](#seroup)
  - [Table of Contents](#table-of-contents)
  - [Installation](#installation)
  - [Usage](#usage)
  - [Commands](#commands)
  - [Configuration](#configuration)

## Installation

To install `seroup`, use pip:

```sh
pip install seroup
```

## Usage

After installation, you can use the seroup command followed by various subcommands.

```sh
seroup <command> <directory (default: current directory)>
```

## Commands

| Command        | Description                                       |
| -------------- | ------------------------------------------------- |
| `init`         | Create default `sero.toml` in specified directory |
| `enable`       | Enable site                                       |
| `disable`      | Disable site                                      |
| `download`     | Download full site as zip                         |
| `upload`       | Upload site                                       |
| `teardown`     | Teardown site                                     |
| `ucors`        | Update CORS settings without reuploading site     |
| `registration` | Register a user in sero server                    |

## Configuration

The tool uses a configuration file named `sero.toml` to manage site settings. Below is an example configuration:

```toml
[server]
url = "http://mysite.ru"
subdomain = "blog"

[cors]
origins = []

[credentials]
login = "clowzed"
# For security reasons
# you'd better keep this empty
password = ""
```

Configuration Sections

- [server]: Contains the server URL and subdomain.
  - url: The base URL of the server.
  - subdomain: The subdomain for the site.
- [cors]: Contains CORS settings.
  - origins: A list of allowed origins for CORS.
- [credentials]: Contains login credentials.
  - login: The login username.
  - password: The login password.

