4c5c35d714
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [requests](https://requests.readthedocs.io) ([source](https://github.com/psf/requests), [changelog](https://github.com/psf/requests/blob/master/HISTORY.md)) | dependencies | minor | `2.30.0` -> `2.31.0` | --- ### Release Notes <details> <summary>psf/requests</summary> ### [`v2.31.0`](https://github.com/psf/requests/blob/HEAD/HISTORY.md#​2310-2023-05-22) [Compare Source](https://github.com/psf/requests/compare/v2.30.0...v2.31.0) **Security** - Versions of Requests between v2.3.0 and v2.30.0 are vulnerable to potential forwarding of `Proxy-Authorization` headers to destination servers when following HTTPS redirects. When proxies are defined with user info (https://user:pass@proxy:8080), Requests will construct a `Proxy-Authorization` header that is attached to the request to authenticate with the proxy. In cases where Requests receives a redirect response, it previously reattached the `Proxy-Authorization` header incorrectly, resulting in the value being sent through the tunneled connection to the destination server. Users who rely on defining their proxy credentials in the URL are *strongly* encouraged to upgrade to Requests 2.31.0+ to prevent unintentional leakage and rotate their proxy credentials once the change has been fully deployed. Users who do not use a proxy or do not supply their proxy credentials through the user information portion of their proxy URL are not subject to this vulnerability. Full details can be read in our [Github Security Advisory](https://github.com/psf/requests/security/advisories/GHSA-j8r2-6x86-q33q) and [CVE-2023-32681](https://nvd.nist.gov/vuln/detail/CVE-2023-32681). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS42MS4wIiwidXBkYXRlZEluVmVyIjoiMzUuNjEuMCJ9--> Co-authored-by: Renovate Bot <renovate@localhost.localdomain> Reviewed-on: #12 Co-authored-by: renovate <renovate@noreply.localhost> Co-committed-by: renovate <renovate@noreply.localhost> |
||
---|---|---|
doxy | ||
tests | ||
.gitignore | ||
.pre-commit-config.yaml | ||
README.md | ||
config.example.yml | ||
poetry.lock | ||
pyproject.toml | ||
renovate.json |
README.md
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