gdrosos / divio-cli

Command line interface to the Divio Cloud (formerly aldryn-client)

Home Page:http://control.divio.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Divio CLI - Command-line interface to the Divio Cloud

PyPI Version PyPI Downloads Wheel Support License

Installing

pip install divio-cli

⚠️ For Windows users: Make sure you have added Python to PATH during installation, otherwise you must add it manually for the divio-cli commands to function properly.

Using the CLI

See Divio developer handbook: How to use the Divio command-line interface

Support for docker-compose 1 and 2

The CLI supports version 1 (docker-compose) and version 2 (docker compose) of the command invocation. At the time of this writing, the CLI will use v1 command invocation by default because v2 is still in beta. This will likely change in the future.

You can opt-in to use the new command by updating your CLI global settings in ~/.aldryn and add a new setting called docker-compose with the value ["docker", "compose"].

Testing

We have two kinds of tests. Small and quick unit tests and the more complex and involved integration tests.

Unit tests

These do not require external communication and can be run with the following command:

tox -- -m "not integration"

Integration tests

These do require a more involved setup and will trigger actions on a real project. You have to provide the project name and your user must be logged in into divio cloud.

You might get asked to provide authentication information during the test, depending on your setup.

tox --  -m "integration" --test_project_name <NAME_OF_A_PROJECT_FOR_TESTING>

Creating a release

  1. Checkout a new branch for the new version - release-X.X.X
  2. Update the changelog.
  3. Merge the branch (after approval).
  4. Tag master with the release number X.X.X and git push origin <tagname>

The pipeline will then take care of the release.

About

Command line interface to the Divio Cloud (formerly aldryn-client)

http://control.divio.com

License:Other


Languages

Language:Python 100.0%Language:Makefile 0.0%