Metadata-Version: 2.1
Name: pydeployhelp
Version: 1.2.4
Summary: Deploy helper for Python projects
Home-page: https://github.com/igorezersky/pydeployhelp
Author: Igor Ezersky
Author-email: igor.ezersky.private@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# pydeployhelp

## Overview

`pydeployhelp` is aimed to help integrating deploy (*via Docker*) to Python projects. It can be used both as
external library (all processors can be imported) and as CLI tool.

Following CLI tools will be available after installation:

- `pydeployhelp-quickstart`: creates directory with deploy service files templates (*Dockerfile, docker-compose, configs*)

- `pydeployhelp`: performs deploy according to info from deploy directory crated by `pydeployhelp-quickstart`

## Installation

`pydeployhelp` can be installed from `PyPi`:

```properties
pip install pydeployhelp
```

Or locally (inside project directory):

```properties
python setup.py install
```

`pydeployhelp-quickstart` tool and all code library can be used without any external system packages installation.

`pydeployhelp` requires following external packages to be installed:

- [Docker](https://docs.docker.com/)

- [docker-compose](https://docs.docker.com/compose/)

### Updating to newer versions

```properties
python -m pip install --upgrade --no-cache-dir pydeployhelp
```

## Usage

### pydeployhelp-quickstart

```text
usage: pydeployhelp-quickstart [-h] [-s] [-v]

optional arguments:
  -h, --help    show this help message and exit
  -s, --silent  If specified, all communication with user will be ignored, default values will be used instead
  -v, --version         Print version and exit
```

Executing in ordinary way (without `--silent`) you will be asked to enter some info
(*project name, deploy directory location, supported tasks*),
soon after that you will see message about service files creation status.

### pydeployhelp

```text
usage: pydeployhelp [-h] [-d DEPLOYDIR] [-s] [-v]

optional arguments:
  -h, --help            show this help message and exit
  -d DEPLOYDIR, --deploydir DEPLOYDIR
                        Path to directory with deploy scripts (normally generated via `pydeployhelp-quickstart`)
  -s, --silent          If specified, all communication with user will be ignored, default values will be used instead
  -v, --version         Print version and exit
```

Executing in ordinary way (without `--silent`) you will be asked to enter some info
(*task names, services names*),
soon after that you will see message about deploy status.


