6782e6a1d1
Welcome to [Renovate](https://github.com/renovatebot/renovate)! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin. 🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged. --- ### Detected Package Files * `pyproject.toml` (poetry) ### Configuration Summary Based on the default config's presets, Renovate will: - Start dependency updates only once this onboarding PR is merged - Enable Renovate Dependency Dashboard creation. - Use semantic commit type `fix` for dependencies and `chore` for all others if semantic commits are in use. - Ignore `node_modules`, `bower_components`, `vendor` and various test/tests directories. - Group known monorepo packages together. - Use curated list of recommended non-monorepo package groupings. - Apply crowd-sourced package replacement rules. - Apply crowd-sourced workarounds for known problems with packages. 🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the `renovate.json` in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs. --- ### What to Expect With your current configuration, Renovate will create 4 Pull Requests: <details> <summary>fix(deps): update dependency requests to v2.29.0</summary> - Schedule: ["at any time"] - Branch name: `renovate/requests-2.x-lockfile` - Merge into: `master` - Upgrade [requests](https://github.com/psf/requests) to `2.29.0` </details> <details> <summary>chore(deps): update dependency pre-commit to v3</summary> - Schedule: ["at any time"] - Branch name: `renovate/pre-commit-3.x` - Merge into: `master` - Upgrade [pre-commit](https://github.com/pre-commit/pre-commit) to `^3.0.0` </details> <details> <summary>chore(deps): update dependency pytest to v7</summary> - Schedule: ["at any time"] - Branch name: `renovate/pytest-7.x` - Merge into: `master` - Upgrade [pytest](https://github.com/pytest-dev/pytest) to `^7.0.0` </details> <details> <summary>fix(deps): update dependency semver to v3</summary> - Schedule: ["at any time"] - Branch name: `renovate/semver-3.x` - Merge into: `master` - Upgrade [semver](https://github.com/python-semver/python-semver) to `^3.0.0` </details> <br /> 🚸 Branch creation will be limited to maximum 2 per hour, so it doesn't swamp any CI resources or overwhelm the project. See docs for `prhourlylimit` for details. --- ❓ Got questions? Check out Renovate's [Docs](https://docs.renovatebot.com/), particularly the Getting Started section. If you need any further assistance then you can also [request help here](https://github.com/renovatebot/renovate/discussions). --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: Renovate Bot <renovate@localhost.localdomain> Reviewed-on: #1 Co-authored-by: renovate <renovate@noreply.localhost> Co-committed-by: renovate <renovate@noreply.localhost> |
||
|---|---|---|
| doxy | ||
| tests | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| config.example.yml | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
| renovate.json | ||
Doxy
Installation
pipx install git+https://github.com/jaypikay/doxy.git
Shell completion
Service name completion
By enabling shell completion the service names are TAB-Completted when using the control
command.
Configuration
Save the configuration file in ~/.config/doxy/config.yml:
root_directory: "/path/to/docker/services"
compose_executable: "/usr/bin/docker-compose"
If you use docker compose instead of docker-compose you can use a wrapper script for
docker-compose
#!/bin/bash
/usr/bin/docker compose $@
exit 0
Usage
Usage: doxy [OPTIONS] COMMAND [ARGS]...
Options:
-f, --format [fancy|simple] output formatting [default: fancy]
--help Show this message and exit.
Commands:
control run docker-compose commands
edit edit the compose file
list list available services
update pull the latest service images and restart
Examples
List available services
$ doxy list
Available Services
├── service-1
├── service-2
├── other-service
└── my-service-demo
When doxy -f simple is used the output is easier to process by pipes.
Start a service and detach
$ doxy control other-service up -d
Edit a service
$ doxy edit service-2
Bash
Alternative 1
Add this to ~/.bashrc:
eval "$(_DOXY_COMPLETE=bash_source doxy)"
Alternative 2
Save the script:
_DOXY_COMPLETE=bash_source doxy > ~/.doxy-complete.bash
Add this to ~/.bashrc:
. ~/.foo-bar-complete.bash
Zsh
Alternative 1
Add this to ~/.zshrc:
eval "$(_DOXY_COMPLETE=zsh_source doxy)"
Alternative 2
Save the script:
_DOXY_COMPLETE=zsh_source doxy > ~/.doxy-complete.zsh
Add this to ~/.zshrc:
. ~/.foo-bar-complete.zsh