omauger/docker-compose-php

A Docker Compose PHP client

2.1 2016-12-08 12:58 UTC

This package is not auto-updated.

Last update: 2024-04-27 16:08:59 UTC


README

Docker-compose PHP is a Docker-compose SDK written in PHP. This library is still a work in progress. Not much is supported yet, but the goal is to reach 100% of docker-compose options support.

The versions <= 1.0 are compatible with docker client 1.9, docker-compose 1.5 and php 5.6. The version 2.0 is compatible with docker client >= 1.10, docker-compose >= 1.6 and php 5.6.

Travis-CI Documentation Status Scrutinizer Code Quality

Versioning

There is no stable version yet and docker-compose is rapidly evolving, but we still try to semantically version the library according to semver, but shifted a little bit:

  • MAJOR version number stays to 0 until all options of docker-compose 1.5 are covered
  • MINOR version number is incremented when a backward incompatible change is made
  • PATCH version number is incremented when a new feature is added

So basically, if you want the 0.1 version set, pull the tag0.1.0 and you should be fine.

Installation

The recommended way to install Docker PHP is of course to use Composer:

{
    "require": {
        "omauger/docker-compose-php": "@dev"
    }
}

Note: there is no stable version of Docker-compose PHP yet.

Usage

See the documentation Run tests

./scripts/tests.sh

Contributing

Ophélie Mauger

License

The MIT License (MIT)

Copyright (c) 2015 Forges Alterway

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.