Don't recommend the stable branch

Instead recommend the latest tagged release. Docs are automatically updated to use this.
vulekamali · Feb 24, 2017 · a9a8442 · a9a8442
1 parent 6b2d896
commit a9a8442
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 39 deletions.
diff --git a/datapusher/__init__.py b/datapusher/__init__.py
@@ -0,0 +1 @@
+__version__ = '0.0.9'
diff --git a/doc/conf.py b/doc/conf.py
@@ -45,14 +45,15 @@
 
 # General information about the project.
 project = u'DataPusher'
-copyright = u'2013, Open Knowledge Foundation'
+copyright = u'2017, Open Knowledge International'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = '1.0'
+import datapusher
+version = datapusher.__version__
+
 # The full version, including alpha/beta/rc tags.
 release = '1.0'
 
@@ -192,7 +193,7 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'datapusher.tex', u'datapusher Documentation',
-   u'Open Knowledge Foundation', 'manual'),
+   u'Open Knowledge International', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -222,7 +223,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'datapusher', u'datapusher Documentation',
-     [u'Open Knowledge Foundation'], 1)
+     [u'Open Knowledge International'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -236,7 +237,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index', 'datapusher', u'datapusher Documentation',
-   u'Open Knowledge Foundation', 'datapusher', 'One line description of project.',
+   u'Open Knowledge International', 'datapusher', 'One line description of project.',
    'Miscellaneous'),
 ]
 

diff --git a/doc/deployment.rst b/doc/deployment.rst
@@ -18,45 +18,45 @@ your needs.
 These instructions set up the |datapusher| webservice on Apache running on port
 8800.
 
-::
+   .. parsed-literal::
 
-    #install requirements for the DataPusher
-    sudo apt-get install python-dev python-virtualenv build-essential libxslt1-dev libxml2-dev git
+	 #install requirements for the DataPusher
+	 sudo apt-get install python-dev python-virtualenv build-essential libxslt1-dev libxml2-dev git
 
-    #create a virtualenv for datapusher
-    sudo virtualenv /usr/lib/ckan/datapusher
+	 #create a virtualenv for datapusher
+	 sudo virtualenv /usr/lib/ckan/datapusher
 
-    #create a source directory and switch to it
-    sudo mkdir /usr/lib/ckan/datapusher/src
-    cd /usr/lib/ckan/datapusher/src
+	 #create a source directory and switch to it
+	 sudo mkdir /usr/lib/ckan/datapusher/src
+	 cd /usr/lib/ckan/datapusher/src
 
-    #clone the source (always target the stable branch)
-    sudo git clone -b stable https://github.com/ckan/datapusher.git
+	 #clone the source (this should target the latest tagged version)
+	 sudo git clone -b |version| https://github.com/ckan/datapusher.git
 
-    #install the DataPusher and its requirements
-    cd datapusher
-    sudo /usr/lib/ckan/datapusher/bin/pip install -r requirements.txt
-    sudo /usr/lib/ckan/datapusher/bin/python setup.py develop
+	 #install the DataPusher and its requirements
+	 cd datapusher
+	 sudo /usr/lib/ckan/datapusher/bin/pip install -r requirements.txt
+	 sudo /usr/lib/ckan/datapusher/bin/python setup.py develop
 
-    #copy the standard Apache config file
-    # (use deployment/datapusher.apache2-4.conf if you are running under Apache 2.4)
-    sudo cp deployment/datapusher.conf /etc/apache2/sites-available/datapusher.conf
+	 #copy the standard Apache config file
+	 # (use deployment/datapusher.apache2-4.conf if you are running under Apache 2.4)
+	 sudo cp deployment/datapusher.conf /etc/apache2/sites-available/datapusher.conf
 
-    #copy the standard DataPusher wsgi file
-    #(see note below if you are not using the default CKAN install location)
-    sudo cp deployment/datapusher.wsgi /etc/ckan/
+	 #copy the standard DataPusher wsgi file
+	 #(see note below if you are not using the default CKAN install location)
+	 sudo cp deployment/datapusher.wsgi /etc/ckan/
 
-    #copy the standard DataPusher settings.
-    sudo cp deployment/datapusher_settings.py /etc/ckan/
+	 #copy the standard DataPusher settings.
+	 sudo cp deployment/datapusher_settings.py /etc/ckan/
 
-    #open up port 8800 on Apache where the DataPusher accepts connections.
-    #make sure you only run these 2 functions once otherwise you will need
-    #to manually edit /etc/apache2/ports.conf.
-    sudo sh -c 'echo "NameVirtualHost *:8800" >> /etc/apache2/ports.conf'
-    sudo sh -c 'echo "Listen 8800" >> /etc/apache2/ports.conf'
+	 #open up port 8800 on Apache where the DataPusher accepts connections.
+	 #make sure you only run these 2 functions once otherwise you will need
+	 #to manually edit /etc/apache2/ports.conf.
+	 sudo sh -c 'echo "NameVirtualHost *:8800" >> /etc/apache2/ports.conf'
+	 sudo sh -c 'echo "Listen 8800" >> /etc/apache2/ports.conf'
 
-    #enable DataPusher Apache site
-    sudo a2ensite datapusher
+	 #enable DataPusher Apache site
+	 sudo a2ensite datapusher
 
 .. note:: If you are installing the |datapusher| on a different location than
     the default one you need to adapt the following line in the
@@ -71,7 +71,8 @@ The `wsgi.py` file provided lets you run datapusher with gunicorn if required.
 You will need to run gunicorn under supervisor and configure Nginx or Apache to
 proxy requests to gunicorn.
 
-::
+
+   .. parsed-literal::
 
     #install requirements for the DataPusher
     sudo apt-get install python-dev python-virtualenv build-essential libxslt1-dev libxml2-dev git
@@ -83,8 +84,8 @@ proxy requests to gunicorn.
     sudo mkdir /usr/lib/ckan/datapusher/src
     cd /usr/lib/ckan/datapusher/src
 
-    #clone the source (always target the stable branch)
-    sudo git clone -b stable https://github.com/ckan/datapusher.git
+    #clone the source (this should target the latest tagged version)
+    sudo git clone -b |version| https://github.com/ckan/datapusher.git
 
     #install the DataPusher and its requirements
     cd datapusher

diff --git a/setup.py b/setup.py
@@ -2,6 +2,9 @@
 from codecs import open  # To use a consistent encoding
 from os import path
 
+from datapusher import __version__
+
+
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the relevant file
@@ -14,7 +17,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # http://packaging.python.org/en/latest/tutorial.html#version
-    version='0.0.8',
+    version=__version__,
 
     description="A standalone web service that parses the contents of a CKAN site's data files and pushes them into its DataStore",
     long_description=long_description,