Aanand Prasad 12 anos atrás
pai
commit
0cafdc9c6c

+ 19 - 19
README.md

@@ -1,9 +1,9 @@
-Plum
+Fig
 ====
 
 **WARNING**: This is a work in progress and probably won't work yet. Feedback welcome.
 
-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:
+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:
 
 ```yaml
 web:
@@ -20,13 +20,13 @@ Installing
 ----------
 
 ```bash
-$ sudo pip install plum
+$ sudo pip install fig
 ```
 
 Defining your app
 -----------------
 
-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.
+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.
 
 The simplest way to get started is to just give it an image name:
 
@@ -35,26 +35,26 @@ db:
   image: orchardup/postgresql
 ```
 
-You've now given Plum the minimal amount of configuration it needs to run:
+You've now given Fig the minimal amount of configuration it needs to run:
 
 ```bash
-$ plum start
+$ fig start
 Pulling image orchardup/postgresql...
 Starting myapp_db_1...
 myapp_db_1 is running at 127.0.0.1:45678
 <...output from postgresql server...>
 ```
 
-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`.
+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`.
 
-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:
+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:
 
 ```bash
-$ plum start -d
+$ fig start -d
 Starting myapp_db_1... done
 myapp_db_1 is running at 127.0.0.1:45678
 
-$ plum ps
+$ fig ps
 Name         State  Ports
 ------------------------------------
 myapp_db_1   Up     5432->45678/tcp
@@ -62,7 +62,7 @@ myapp_db_1   Up     5432->45678/tcp
 
 ### Building services
 
-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).
+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).
 
 This example will build an image with `app.py` inside it:
 
@@ -72,7 +72,7 @@ This example will build an image with `app.py` inside it:
 print "Hello world!"
 ```
 
-#### plum.yml
+#### fig.yml
 
 ```yaml
 web:
@@ -91,7 +91,7 @@ web:
 
 ### Getting your code in
 
-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:
+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:
 
 ```yaml
 web:
@@ -118,8 +118,8 @@ web:
 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:
 
 ```bash
-$ plum start -d db
-$ plum run web env
+$ fig start -d db
+$ fig run web env
 ```
 
 
@@ -152,12 +152,12 @@ web:
 Running a one-off command
 -------------------------
 
-If you want to run a management command, use `plum run` to start a one-off container:
+If you want to run a management command, use `fig run` to start a one-off container:
 
 ```bash
-$ plum run db createdb myapp_development
-$ plum run web rake db:migrate
-$ plum run web bash
+$ fig run db createdb myapp_development
+$ fig run web rake db:migrate
+$ fig run web bash
 ```
 
 

+ 0 - 0
plum/__init__.py → fig/__init__.py


+ 0 - 0
plum/cli/__init__.py → fig/cli/__init__.py


+ 0 - 0
plum/cli/colors.py → fig/cli/colors.py


+ 1 - 1
plum/cli/command.py → fig/cli/command.py

@@ -21,7 +21,7 @@ class Command(DocoptCommand):
 
     @cached_property
     def project(self):
-        config = yaml.load(open('plum.yml'))
+        config = yaml.load(open('fig.yml'))
         return Project.from_config(self.project_name, config, self.client)
 
     @cached_property

+ 0 - 0
plum/cli/docopt_command.py → fig/cli/docopt_command.py


+ 0 - 0
plum/cli/errors.py → fig/cli/errors.py


+ 0 - 0
plum/cli/formatter.py → fig/cli/formatter.py


+ 0 - 0
plum/cli/log_printer.py → fig/cli/log_printer.py


+ 3 - 3
plum/cli/main.py → fig/cli/main.py

@@ -62,8 +62,8 @@ class TopLevelCommand(Command):
     """.
 
     Usage:
-      plum [options] [COMMAND] [ARGS...]
-      plum -h|--help
+      fig [options] [COMMAND] [ARGS...]
+      fig -h|--help
 
     Options:
       --verbose            Show more output
@@ -82,7 +82,7 @@ class TopLevelCommand(Command):
     """
     def docopt_options(self):
         options = super(TopLevelCommand, self).docopt_options()
-        options['version'] = "plum %s" % __version__
+        options['version'] = "fig %s" % __version__
         return options
 
     def ps(self, options):

+ 0 - 0
plum/cli/multiplexer.py → fig/cli/multiplexer.py


+ 0 - 0
plum/cli/socketclient.py → fig/cli/socketclient.py


+ 0 - 0
plum/cli/utils.py → fig/cli/utils.py


+ 0 - 0
plum/container.py → fig/container.py


+ 0 - 0
plum/project.py → fig/project.py


+ 0 - 0
plum/service.py → fig/service.py


+ 5 - 5
setup.py

@@ -23,19 +23,19 @@ def find_version(*file_paths):
 
 
 setup(
-    name='plum',
-    version=find_version("plum", "__init__.py"),
+    name='fig',
+    version=find_version("fig", "__init__.py"),
     description='',
-    url='https://github.com/orchardup/plum',
+    url='https://github.com/orchardup/fig',
     author='Orchard Laboratories Ltd.',
     author_email='[email protected]',
-    packages=['plum'],
+    packages=['fig'],
     package_data={},
     include_package_data=True,
     install_requires=[],
     dependency_links=[],
     entry_points="""
     [console_scripts]
-    plum=plum.cli.main:main
+    fig=fig.cli.main:main
     """,
 )

+ 1 - 1
tests/container_test.py

@@ -1,5 +1,5 @@
 from .testcases import DockerClientTestCase
-from plum.container import Container
+from fig.container import Container
 
 class ContainerTest(DockerClientTestCase):
     def test_from_ps(self):

+ 2 - 2
tests/project_test.py

@@ -1,5 +1,5 @@
-from plum.project import Project
-from plum.service import Service
+from fig.project import Project
+from fig.service import Service
 from .testcases import DockerClientTestCase
 
 

+ 1 - 1
tests/service_test.py

@@ -1,4 +1,4 @@
-from plum import Service
+from fig import Service
 from .testcases import DockerClientTestCase
 
 

+ 1 - 1
tests/testcases.py

@@ -1,5 +1,5 @@
 from docker import Client
-from plum.service import Service
+from fig.service import Service
 import os
 from unittest import TestCase