seroup


Nameseroup JSON
Version 0.2.6 PyPI version JSON
download
home_pageNone
SummaryCLI tool to manage sero servers
upload_time2024-08-06 00:37:58
maintainerNone
docs_urlNone
authorclowzed
requires_python<4.0,>=3.12
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "seroup",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "clowzed",
    "author_email": "clowzed.work@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/29/84/e8765ba06a15e124c77ff2bb10b217cecedbdb24be14c90220de1d42b862/seroup-0.2.6.tar.gz",
    "platform": null,
    "description": "# Seroup\n\nSeroup is a CLI management tool for [sero](https://github.com/clowzed/sero) servers, allowing you to easily upload and manage site on this server.\nThe last version of this tool is guaranteed to work with latest stable release of sero server.\n\n## Table of Contents\n\n- [Seroup](#seroup)\n  - [Table of Contents](#table-of-contents)\n  - [Installation](#installation)\n  - [Usage](#usage)\n  - [Commands](#commands)\n  - [Configuration](#configuration)\n\n## Installation\n\nTo install `seroup`, use pip:\n\n```sh\npip install seroup\n```\n\n## Usage\n\nAfter installation, you can use the seroup command followed by various subcommands.\n\n```sh\nseroup <command> <directory (default: current directory)>\n```\n\n## Commands\n\n| Command        | Description                                       |\n| -------------- | ------------------------------------------------- |\n| `init`         | Create default `sero.toml` in specified directory |\n| `enable`       | Enable site                                       |\n| `disable`      | Disable site                                      |\n| `download`     | Download full site as zip                         |\n| `upload`       | Upload site                                       |\n| `teardown`     | Teardown site                                     |\n| `ucors`        | Update CORS settings without reuploading site     |\n| `registration` | Register a user in sero server                    |\n\n## Configuration\n\nThe tool uses a configuration file named `sero.toml` to manage site settings. Below is an example configuration:\n\n```toml\n[server]\nurl = \"http://mysite.ru\"\nsubdomain = \"blog\"\n\n[cors]\norigins = []\n\n[credentials]\nlogin = \"clowzed\"\n# For security reasons\n# you'd better keep this empty\npassword = \"\"\n```\n\nConfiguration Sections\n\n- [server]: Contains the server URL and subdomain.\n  - url: The base URL of the server.\n  - subdomain: The subdomain for the site.\n- [cors]: Contains CORS settings.\n  - origins: A list of allowed origins for CORS.\n- [credentials]: Contains login credentials.\n  - login: The login username.\n  - password: The login password.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "CLI tool to manage sero servers",
    "version": "0.2.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ba7aa3dcab268954fe121e005864a8595e84029bb6af4590e5eec30e3de7eb3",
                "md5": "5fd194854d75c97bf75411995dc38278",
                "sha256": "f6706e7a62bccb13c4f02603d3e5d7b98fa6b97e11f7ffdc46e3d2951fafbc41"
            },
            "downloads": -1,
            "filename": "seroup-0.2.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5fd194854d75c97bf75411995dc38278",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 11256,
            "upload_time": "2024-08-06T00:37:57",
            "upload_time_iso_8601": "2024-08-06T00:37:57.688350Z",
            "url": "https://files.pythonhosted.org/packages/0b/a7/aa3dcab268954fe121e005864a8595e84029bb6af4590e5eec30e3de7eb3/seroup-0.2.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2984e8765ba06a15e124c77ff2bb10b217cecedbdb24be14c90220de1d42b862",
                "md5": "44919e90b04deacfae3b9ff093c351d9",
                "sha256": "b493a72f154bd31ba3e3a48197f6b8a45dd2fff9871139d2992c394c5ca9598a"
            },
            "downloads": -1,
            "filename": "seroup-0.2.6.tar.gz",
            "has_sig": false,
            "md5_digest": "44919e90b04deacfae3b9ff093c351d9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 6658,
            "upload_time": "2024-08-06T00:37:58",
            "upload_time_iso_8601": "2024-08-06T00:37:58.771236Z",
            "url": "https://files.pythonhosted.org/packages/29/84/e8765ba06a15e124c77ff2bb10b217cecedbdb24be14c90220de1d42b862/seroup-0.2.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-06 00:37:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "seroup"
}
        
Elapsed time: 0.48792s