Skip to content

Commit 0cafdc9

Browse files
committed
plum -> fig
1 parent 4d35d47 commit 0cafdc9

21 files changed

Lines changed: 33 additions & 33 deletions

‎README.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Plum
1+
Fig
22
====
33

44
**WARNING**: This is a work in progress and probably won't work yet. Feedback welcome.
55

6-
Plum is tool for defining and running application environments with Docker. It uses a simple, version-controllable YAML configuration file that looks something like this:
6+
Fig is tool for defining and running application environments with Docker. It uses a simple, version-controllable YAML configuration file that looks something like this:
77

88
```yaml
99
web:
@@ -20,13 +20,13 @@ Installing
2020
----------
2121
2222
```bash
23-
$ sudo pip install plum
23+
$ sudo pip install fig
2424
```
2525

2626
Defining your app
2727
-----------------
2828

29-
Put a `plum.yml` in your app's directory. Each top-level key defines a "service", such as a web app, database or cache. For each service, Plum will start a Docker container, so at minimum it needs to know what image to use.
29+
Put a `fig.yml` in your app's directory. Each top-level key defines a "service", such as a web app, database or cache. For each service, Fig will start a Docker container, so at minimum it needs to know what image to use.
3030

3131
The simplest way to get started is to just give it an image name:
3232

@@ -35,34 +35,34 @@ db:
3535
image: orchardup/postgresql
3636
```
3737
38-
You've now given Plum the minimal amount of configuration it needs to run:
38+
You've now given Fig the minimal amount of configuration it needs to run:
3939
4040
```bash
41-
$ plum start
41+
$ fig start
4242
Pulling image orchardup/postgresql...
4343
Starting myapp_db_1...
4444
myapp_db_1 is running at 127.0.0.1:45678
4545
<...output from postgresql server...>
4646
```
4747

48-
For each service you've defined, Plum will start a Docker container with the specified image, building or pulling it if necessary. You now have a PostgreSQL server running at `127.0.0.1:45678`.
48+
For each service you've defined, Fig will start a Docker container with the specified image, building or pulling it if necessary. You now have a PostgreSQL server running at `127.0.0.1:45678`.
4949

50-
By default, `plum start` will run until each container has shut down, and relay their output to the terminal. To run in the background instead, pass the `-d` flag:
50+
By default, `fig start` will run until each container has shut down, and relay their output to the terminal. To run in the background instead, pass the `-d` flag:
5151

5252
```bash
53-
$ plum start -d
53+
$ fig start -d
5454
Starting myapp_db_1... done
5555
myapp_db_1 is running at 127.0.0.1:45678
5656

57-
$ plum ps
57+
$ fig ps
5858
Name State Ports
5959
------------------------------------
6060
myapp_db_1 Up 5432->45678/tcp
6161
```
6262

6363
### Building services
6464

65-
Plum can automatically build images for you if your service specifies a directory with a `Dockerfile` in it (or a Git URL, as per the `docker build` command).
65+
Fig can automatically build images for you if your service specifies a directory with a `Dockerfile` in it (or a Git URL, as per the `docker build` command).
6666

6767
This example will build an image with `app.py` inside it:
6868

@@ -72,7 +72,7 @@ This example will build an image with `app.py` inside it:
7272
print "Hello world!"
7373
```
7474

75-
#### plum.yml
75+
#### fig.yml
7676

7777
```yaml
7878
web:
@@ -91,7 +91,7 @@ web:
9191
9292
### Getting your code in
9393
94-
If you want to work on an application being run by Plum, you probably don't want to have to rebuild your image every time you make a change. To solve this, you can share the directory with the container using a volume so the changes are reflected immediately:
94+
If you want to work on an application being run by Fig, you probably don't want to have to rebuild your image every time you make a change. To solve this, you can share the directory with the container using a volume so the changes are reflected immediately:
9595
9696
```yaml
9797
web:
@@ -118,8 +118,8 @@ web:
118118
This will pass an environment variable called `MYAPP_DB_1_PORT` into the web container, whose value will look like `tcp://172.17.0.4:45678`. Your web app's code can use that to connect to the database. To see all of the environment variables available, run `env` inside a container:
119119

120120
```bash
121-
$ plum start -d db
122-
$ plum run web env
121+
$ fig start -d db
122+
$ fig run web env
123123
```
124124

125125

@@ -152,12 +152,12 @@ web:
152152
Running a one-off command
153153
-------------------------
154154

155-
If you want to run a management command, use `plum run` to start a one-off container:
155+
If you want to run a management command, use `fig run` to start a one-off container:
156156

157157
```bash
158-
$ plum run db createdb myapp_development
159-
$ plum run web rake db:migrate
160-
$ plum run web bash
158+
$ fig run db createdb myapp_development
159+
$ fig run web rake db:migrate
160+
$ fig run web bash
161161
```
162162

163163

File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def client(self):
2121

2222
@cached_property
2323
def project(self):
24-
config = yaml.load(open('plum.yml'))
24+
config = yaml.load(open('fig.yml'))
2525
return Project.from_config(self.project_name, config, self.client)
2626

2727
@cached_property
File renamed without changes.

plum/cli/main.py renamed to fig/cli/main.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ class TopLevelCommand(Command):
6262
""".
6363
6464
Usage:
65-
plum [options] [COMMAND] [ARGS...]
66-
plum -h|--help
65+
fig [options] [COMMAND] [ARGS...]
66+
fig -h|--help
6767
6868
Options:
6969
--verbose Show more output
@@ -82,7 +82,7 @@ class TopLevelCommand(Command):
8282
"""
8383
def docopt_options(self):
8484
options = super(TopLevelCommand, self).docopt_options()
85-
options['version'] = "plum %s" % __version__
85+
options['version'] = "fig %s" % __version__
8686
return options
8787

8888
def ps(self, options):

0 commit comments

Comments
 (0)