compose_yml 0.0.45

Parse, manipulate and serialize docker-compose.yml in a strongly-typed fashion
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# `compose_yml`: Support for working with `docker-compose.yml` files

[![Latest version](https://img.shields.io/crates/v/compose_yml.svg)](https://crates.io/crates/compose_yml) [![License](https://img.shields.io/crates/l/compose_yml.svg)](https://creativecommons.org/publicdomain/zero/1.0/) [![Build Status](https://travis-ci.org/emk/compose_yml.svg?branch=master)](https://travis-ci.org/emk/compose_yml)

**This is a work in progress!** Most of `services:` is supported, but I'm
still refining the APIs as higher-level tools get build around this.

[API Documention](http://docs.randomhacks.net/compose_yml/)

## Goals

`docker-compose.yml` is a very useful format, but it's hard to parse and
transform correctly.  This library aims to offer:

- High-level, type-safe APIs for anything you can find in a
  `docker-compose.yml` file.
- Parsing of individual string fields into real objects.
- Support for working with strings that might contain variable
  interpolations, and leaving them unparsed when necessary.
- Canonical representations of fields which may have multiple formats.
- Easy updates when `docker-compose.yml` gets extended.

## Building

You can build this library using stable Rust version 1.11.  But if you want
to develop it, you will get _much_ better error messages using a nightly
build of Rust.

```sh
# Install Rust stable and nightly using rustup.
curl -sSf https://static.rust-lang.org/rustup.sh | sh
rustup toolchain install nightly

# Build unit tests using nightly Rust.
rustup run nightly cargo test --no-default-features --features unstable
```

## Sponsor

<a href="http://www.faraday.io"><img
src="http://cdn2.hubspot.net/hubfs/515497/img/logo.svg" alt="Faraday
logo"/></a>

Part of the work on [`compose_yml`][compose_yml] has been
generously sponsored by [Faraday][] for use in
their [`conductor`][conductor] tool, which orchestrates `docker-compose`
for large, multi-pod apps.

[Faraday]: http://www.faraday.io/
[conductor]: https://github.com/faradayio/conductor
[compose_yml]: https://github.com/emk/compose_yml