Skip to content

Commit

Permalink
add a license and changes file and update the README with new license…
Browse files Browse the repository at this point in the history
…, URL and make sure .txt and .rst files are copied
  • Loading branch information
natea committed Apr 8, 2013
1 parent e3cb39f commit 70ec421
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 16 deletions.
14 changes: 14 additions & 0 deletions CHANGES.rst
@@ -0,0 +1,14 @@
0.1.2 (2013-04-08)
++++++++++++++++++

- Fixed bug with missing README.rst (@natea)

0.1.1 (2013-03-26)
++++++++++++++++++

- Added support for Google App Engine (@natea, @littleq0903)

0.1.0 (2012-09-07)
++++++++++++++++++

- Initial version for Stackato and Dotcloud (@natea, @johnthedebs)
9 changes: 9 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,9 @@
The MIT License (MIT)

Copyright (c) 2013 Nate Aune

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.
31 changes: 24 additions & 7 deletions README.rst
@@ -1,21 +1,38 @@
django-deployer
===============

Universal deployment tool for Django that currently deploys any Django app to the following PaaS providers:
django-deployer is a deployment tool for Django that currently deploys any Django app to the following PaaS providers:
Dotcloud, Stackato and Google App Engine.

The goal of django-deployer is to minimize the effort to deploy a Django app to any of the popular PaaS providers. It asks a series of questions about your Django project, and then generates a generic deploy.yml file that captures all of your project's requirements. django-deployer then uses this deploy.yml file to translate these requirements into specific configurations for each PaaS.

See the roadmap below for adding support for more providers: Heroku, OpenShift, Elastic Beanstalk and Gondor.

Getting Started
---------------

When it's available on PyPi you'll be available to do this:
To install django-deployer, use ``pip`` to fetch the package from PyPi:

.. code:: bash
$ pip install django-deployer
Until then, you can git clone it, and from your project's virtualenv:
From your project's root directory:

.. code:: bash
$ deployer-init
$ fab setup
...
Now inspect your project directory and you will see that a file ``deploy.yml`` and various config files were created.

**Note:** if you're going to try different PaaS providers, it's recommended that you make a separate git branch for each one, because when you re-run ``fab setup`` it could inadvertently overwrite the config files from the first run.

Contribute
----------

If you want to develop django-deployer, you can clone it and install it into your project's virtualenv:

.. code:: bash
Expand All @@ -24,14 +41,14 @@ Until then, you can git clone it, and from your project's virtualenv:
(venv)$ cd django-deployer
(venv)$ python setup.py develop
From your project's root directory:
Or you can also install an editable source version of it using pip:

.. code:: bash
$ deployer-init
$ fab setup
$ source bin/activate
(venv)$ pip install -e git+git://github.com/natea/django-deployer.git#django-deployer
To see a list of available deployer tasks use `fab --list`.
Which will clone the git repo into the ``src`` directory of your project's virtualenv.

Changelog
---------
Expand Down
21 changes: 12 additions & 9 deletions setup.py
Expand Up @@ -7,22 +7,25 @@
setup(
name="django-deployer",
version="0.1.1",
description="Django deployment utility for popular PaaS providers",
long_description=open('README.rst').read(),
description="Django deployment tool for popular PaaS providers",
long_description=open('README.rst').read() + '\n\n' +
open('CHANGES.txt').read(),
keywords="PaaS Django Dotcloud Stackato Heroku Gondor AWS OpenShift GAE appengine fabric deployment",
author="Nate Aune",
author_email="nate@appsembler.com",
url="https://github.com/natea/django-deployer",
url="http://natea.github.io/django-deployer",
license="MIT",
packages=find_packages(),
package_data={'django_deployer':
[
'paas_templates/*/*',
]},
package_data={
'': ['*.txt', '*.rst'],
'django_deployer': ['paas_templates/*/*'],
},
install_requires=[
'fabric==1.6.0', # formerly 1.4.3
'jinja2==2.6',
'heroku==0.1.2',
'dotcloud==0.9.4',
'gondor==1.2.1',
'gondor==1.2.2',
'pyyaml==3.10',
'sphinx==1.1.3',
'requests==0.14.2',
Expand All @@ -32,7 +35,7 @@
"Environment :: Web Environment",
"Framework :: Django",
"Intended Audience :: Developers",
"License :: OSI Approved :: GPL License",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
),
entry_points={
Expand Down

0 comments on commit 70ec421

Please sign in to comment.