Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iyazerski/pydeployhelp
CLI tool that helps integrating deploy (via Docker) to Python projects
https://github.com/iyazerski/pydeployhelp
cli docker docker-compose python yaml
Last synced: 4 months ago
JSON representation
CLI tool that helps integrating deploy (via Docker) to Python projects
- Host: GitHub
- URL: https://github.com/iyazerski/pydeployhelp
- Owner: iyazerski
- License: mit
- Created: 2020-12-16T18:00:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T21:01:55.000Z (over 1 year ago)
- Last Synced: 2024-09-28T21:05:27.444Z (5 months ago)
- Topics: cli, docker, docker-compose, python, yaml
- Language: Python
- Homepage: https://pydeployhelp.readthedocs.io/
- Size: 40 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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`
## Documentation
Please see the latest documentation at [Read the Docs](https://pydeployhelp.readthedocs.io/)
## Installation
`pydeployhelp` can be installed from `PyPi`:
```shell
pip install pydeployhelp
```
Or locally (inside project directory):
```shell
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
```shell
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.