Commits

Sebastian Schulz committed cdd10a1

added license and improved readme

Comments (0)

Files changed (3)

+Copyright (c) 2012 Sebastian Schulz
+
+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.
-# This is my README
+========================
+Django deployment script
+========================
+
+This package provides a fabric script for building and maintaining django 
+web application hosting. The goal is to simplify the deploy process.
+
+Keep in mind, that this script ist still under construction. If you have found
+a bug or you have a suggestion, contact me or fire an issue or send a pull
+request.
+
+Source code: https://bitbucket.org/ses_schulz/django-deployment/src
+
+Bug tracker: https://bitbucket.org/ses_schulz/django-deployment/issues/
+
+Requirements
+============
+
+* Fabric >= 1.4.0
+* Django >= 1.3.1
+
+Installation
+============
+
+::
+
+    pip install git+ssh://git@bitbucket.org/ses_schulz/django-deployment.git
+
+
+Usage
+=====
+
+Create in the root directory of your project a ``fabfile.py``.
+
+Example::
+
+    from fabric.api import env, task
+    import deploy
+
+    @task
+    def config_test():
+        env.hosts = ['example.com', ]
+        env.user = "username"
+        env.VIRTUAL_ENV = "/home/dir-of-project"
+        env.VCS_URL = 'http://example.com/my-git-repo'
+        env.DJANGO_SETTINGS_MODULE = 'settings'
+        env.LOCAL_SETTINGS = 'config/local.py'
+        env.REMOTE_SETTINGS = '%(VIRTUAL_ENV)s/src/settings/local.py' % env
+        env.DJANGO_FCGI_PID = '%(VIRTUAL_ENV)s/django-fcgi.pid' % env
+
+Now you can deploy your django project the first time.
+
+Example::
+
+    fab config_test deploy.first_deploy
+
+New deployments, you can realize with this command
+
+Example::
+
+    fab config_test deploy
+
+
     author_email="ses.bitbucket@sebatec.eu",
     description="This package provides a fabric script for building and maintaining "\
                 "django web application hosting.",
-    license="BSD",
+    license='MIT license',
     keywords="virtual machine server hosting management script",
     url="http://bitbucket.org/ses_schulz/django-deployment/",
+    download_url='https://bitbucket.org/ses_schulz/django-deployment/get/master.zip',
 
     # could also include long_description, download_url, classifiers, etc.
 )
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.