Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improved README.

  • Loading branch information...
commit a19e402146b6c97b0c24a47372b7d11d1323523c 1 parent 96dd615
@jonathanslenders authored
Showing with 25 additions and 27 deletions.
  1. +12 −21 README.md
  2. +13 −6 docs/index.rst
View
33 README.md
@@ -4,25 +4,18 @@ Deployer
[![Build Status](https://travis-ci.org/jonathanslenders/python-deployer.png)](https://travis-ci.org/jonathanslenders/python-deployer)
[![Build Status](https://drone.io/github.com/jonathanslenders/python-deployer/status.png)](https://drone.io/github.com/jonathanslenders/python-deployer/latest)
-The deployer is a Python framework for automatic application deployment on
-Posix systems, usually through SSH. When set up, it can be used as a library or
-through the interactive command line.
-
-Some key features are:
-
- - Interactive execution of remote commands, locally, they will appear in a
- pseudo terminal (created with openpty), so that even editors like Vim or
- Emacs works fine when you run them on the remote end.
- - Reusability of all deployment code is a key point. It's as declarative as
- possible, but without loosing Python's power to express everything as
- dynamic as you'd like to. Deployment code is hierarchically structured, with
- inheritance where possible.
- - Parallel execution is easy when enabled, while keeping interaction with
- these remote processes possible through pseudoterminals. Every process gets
- his own terminal, either a new xterm or gnome-terminal window, a tmux pane, or
- whatever you'd like to.
- - Logging of your deployments. New loggers are easily pluggable into the
- system.
+Framework for remote execution on Posix systems.
+
+Important key features are:
+
+ - Powerful interactive command line with autocompletion;
+ - Interactive and fast parallel execution;
+ - Reusability of your code (through inheritance);
+ - Normally using SSH for remote execution, but pluggable for other execution methods.
+
+It's more powerful than `Fabric`_, but different from `Saltstack`_. It's not
+meant to replace anything, it's another tool for your toolbox.
+
Documentation and tutorial
--------------------------
@@ -48,5 +41,3 @@ of Fabric, I (Jonathan) started the development of a new, interactive
deployment system from scratch. The first successful deployments (of a Django
project) were done only a few months later, but since then, all the code has
been refactored quite a few times.
-
-
View
19 docs/index.rst
@@ -6,8 +6,7 @@
Python-deploy-framework
=======================
-A Python framework for automatic deployment and remote execution on Posix
-systems.
+Framework for remote execution on Posix systems.
* :ref:`genindex`
* :ref:`modindex`
@@ -15,15 +14,23 @@ systems.
Important key features are:
- - Interactive execution of remote commands.
- - Fast parallel execution.
- - Reusability of your code.
+ - Powerful interactive command line with autocompletion;
+ - Interactive and fast parallel execution;
+ - Reusability of your code (through inheritance);
+ - Normally using SSH for remote execution, but pluggable for other execution methods;
+ - Pluggable logging framework;
+ - All scripts can be used as a library, easy to call from another Python application. (No global state.)
-It's more powerful than `Fabric`_, and different from `Saltstack`_
+It's more powerful than `Fabric`_, but different from `Saltstack`_. It's not
+meant to replace anything, it's another tool for your toolbox.
.. _Fabric: http://docs.fabfile.org/
.. _Saltstack: http://saltstack.com
+Questions? Just `create a ticket <create-ticket>`_ in Github for now:
+
+.. _create-ticket: https://github.com/jonathanslenders/python-deployer/issues?state=open
+
- :ref:`Read the tutorial <getting-started>`
- Find the source code at `github`_.
Please sign in to comment.
Something went wrong with that request. Please try again.