{"id":14975916,"url":"https://github.com/iyazerski/pydeployhelp","last_synced_at":"2025-10-27T16:31:52.665Z","repository":{"id":54224459,"uuid":"322062036","full_name":"iyazerski/pydeployhelp","owner":"iyazerski","description":"CLI tool that helps integrating deploy (via Docker) to Python projects","archived":false,"fork":false,"pushed_at":"2023-07-19T21:01:55.000Z","size":41,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-28T21:05:27.444Z","etag":null,"topics":["cli","docker","docker-compose","python","yaml"],"latest_commit_sha":null,"homepage":"https://pydeployhelp.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iyazerski.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-16T18:00:27.000Z","updated_at":"2022-05-16T21:42:56.000Z","dependencies_parsed_at":"2024-09-18T18:03:53.212Z","dependency_job_id":null,"html_url":"https://github.com/iyazerski/pydeployhelp","commit_stats":{"total_commits":33,"total_committers":5,"mean_commits":6.6,"dds":0.1515151515151515,"last_synced_commit":"e40b626d94e3cdcdd345e168ad3d0238bd609166"},"previous_names":["igorezersky/pydeployhelp"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iyazerski%2Fpydeployhelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iyazerski%2Fpydeployhelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iyazerski%2Fpydeployhelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iyazerski%2Fpydeployhelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iyazerski","download_url":"https://codeload.github.com/iyazerski/pydeployhelp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219860932,"owners_count":16556009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","docker","docker-compose","python","yaml"],"created_at":"2024-09-24T13:52:51.489Z","updated_at":"2025-10-27T16:31:52.659Z","avatar_url":"https://github.com/iyazerski.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pydeployhelp\n\n## Overview\n\n`pydeployhelp` is a tool designed to simplify deploying Python projects using Docker. It can be used as a standalone CLI tool, offering flexibility in integrating deployment processes into your Python workflows.\n\nAfter installation, the following CLI tools are available:\n\n- `pydeployhelp`: Deploys your project based on the configuration found in the deployment directory created by `pydeployhelp-quickstart`.\n- `pydeployhelp-quickstart`: Sets up a deployment directory with service file templates, including `Dockerfile`, `docker-compose`, and configuration files.\n\n`pydeployhelp` makes it easy to containerize and manage your Python applications using Docker, saving you time and reducing complexity in the deployment phase.\n\n## Documentation\n\nFor detailed instructions and the latest information, please visit the [official documentation at Read the Docs](https://pydeployhelp.readthedocs.io/).\n\n## Installation\n\n- **Python 3.11 or later** is required.\n\n### Using `pip` (from `PyPi`)\n\n1. Install via `pip`:\n\n   ```bash\n   pip install pydeployhelp\n   ```\n\n2. Now you can use the `pydeployhelp` command:\n\n   ```bash\n   pydeployhelp --help\n   ```\n\n### Using uv (only for developers)\n\n1. Clone this repository:\n\n   ```bash\n   git clone https://github.com/iyazerski/pydeployhelp.git\n   cd pydeployhelp\n   ```\n\n2. Install dependencies via [uv](https://docs.astral.sh/uv/):\n\n   ```bash\n   uv sync\n   ```\n\n3. To run the CLI:\n\n   ```bash\n   uv run pydeployhelp --help\n   ```\n\n\n### Requirements\n\n`pydeployhelp` requires [Docker](https://docs.docker.com/) to be installed on your system. The `pydeployhelp-quickstart` tool and the core library can be used without installing any additional system-level dependencies, making setup straightforward.\n\n### Updating to the Latest Version\n\nTo update to the latest version of `pydeployhelp`, run the following command:\n\n```shell\npython -m pip install --upgrade --no-cache-dir pydeployhelp\n```\n\n## Usage\n\n### `pydeployhelp`\n\nThe main command for deploying your project is `pydeployhelp`. Here is an overview of the available options:\n\n```text\nUsage: pydeployhelp [OPTIONS]\n\nMain entrypoint, which will be called when executing `pydeployhelp` in console.\n\n╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│ --task                         TEXT  List of deployment tasks defined in config.yaml                                                                                             │\n│ --target                       TEXT  List of deployment targets defined in config.yaml                                                                                           │\n│ --deploydir                    TEXT  Path to directory with deploy scripts (normally generated via `pydeployhelp-quickstart`) [default: deploy]                                  │\n│ --silent       --no-silent           Ignore all communication with user and use default values [default: no-silent]                                                              │\n│ --version      --no-version          Print version and exit [default: no-version]                                                                                                │\n│ --help                               Show this message and exit.                                                                                                                 │\n╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n```\n\nRunning `pydeployhelp` without the `--silent` flag will prompt you to provide information such as task names and services. Once completed, a status message regarding the deployment will be displayed.\n\nExample of a non-interactive console mode (you won't be prompted for manual input):\n\n```shell\npydeployhelp --task build --task up --target all\n```\n\nThis command will run the specified deployment tasks (`build` and `up`) for all defined targets.\n\n### `pydeployhelp-quickstart`\n\nThe `pydeployhelp-quickstart` command is used to generate a deployment directory with the necessary service templates. Here is how you can use it:\n\n```text\nUsage: pydeployhelp-quickstart [OPTIONS]\n\n╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│ --silent     --no-silent       Ignore all communication with user and use default values [default: no-silent]                                                                    │\n│ --version    --no-version      Print version and exit [default: no-version]                                                                                                      │\n│ --help                         Show this message and exit.                                                                                                                       │\n╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n```\n\nRunning `pydeployhelp-quickstart` without the `--silent` flag will prompt you to provide information such as the project name, deployment directory location, and supported tasks. Once completed, a status message will indicate the creation of the service files.\n\n## Example Workflow\n\n1. **Quickstart Setup**: Use `pydeployhelp-quickstart` to set up your deployment directory with service templates.\n   ```shell\n   pydeployhelp-quickstart\n   ```\n2. **Edit Configuration**: Customize the generated files (`Dockerfile`, `docker-compose`, etc.) in the deployment directory to suit your project.\n3. **Deploy**: Run `pydeployhelp` to start deploying your project.\n   ```shell\n   pydeployhelp --task build --target all\n   ```\n\nThis workflow helps you easily set up a Docker environment and manage your deployments effectively.\n\n## Contributing\n\nContributions are welcome! If you have any ideas or find a bug, please open an issue or submit a pull request on [GitHub](https://github.com/iyazerski/pydeployhelp).\n\n## License\n\n`pydeployhelp` is released under the MIT License. See the [LICENSE](LICENSE) file for more details.\n\n## Contact\n\nIf you have any questions or feedback, feel free to reach out to the project maintainer:\n- GitHub: [iyazerski](https://github.com/iyazerski)\n\nThank you for using `pydeployhelp`! Happy deploying!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiyazerski%2Fpydeployhelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiyazerski%2Fpydeployhelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiyazerski%2Fpydeployhelp/lists"}