🤝 Merge branch 'master' of https://github.com/moremoban/setupmobans

Author: chfw

README.rst

@@ -5,6 +5,24 @@ setupmobans
 .. image:: https://api.travis-ci.org/moremoban/setupmobans.svg?branch=master
    :target: http://travis-ci.org/moremoban/setupmobans
 
+Scaffolding templates for your Python project. It is used with `yehua <https://github.com/chfw/yehua>`_
+and `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+
+Features
+================================================================================
+
+setup.py
+----------
+
+1. flake8 compliant setup.py
+
+2. feature parity with `kennethreitz/setup.py <https://github.com/kennethreitz/setup.py>`_
+
+   - automatically upload to pypi without using twine
+
+   - automatically do git release while uploading to pypi
+
+3. configured to build universial wheels by default
 
 Installation
 ================================================================================
@@ -15,3 +33,21 @@ You can get it:
 
     $ git clone http://github.com/moremoban/setupmobans.git
 
+
+Notes
+================================================================================
+
+
+In order to run, `python setup.py publish`, you will have setup `.pypirc` in
+your home folder as::
+
+   [distutils]
+   index-servers =
+     pypi
+
+   [pypi]
+   username=your_name
+   password=your_password
+
+
+And you need `gease` installed too.

templates/README.rst.jj2

@@ -22,23 +22,7 @@
 Installation
 ================================================================================
 
-{% if release != '0.0.0' %}
-
-You can install it via pip:
-
-.. code-block:: bash
-
-    $ pip install {{name}}
-
-
-or clone it and install it:
-{% endif %}
-
-.. code-block:: bash
-
-    $ git clone http://github.com/{{organisation}}/{{name}}.git
-    $ cd {{name}}
-    $ python setup.py install
+{% include "installation.rst.jj2" %}
 
 {%block bottom_block%}
 {%endblock%}

templates/__init__.py.jj2

@@ -0,0 +1,3 @@
+# flake8: noqa
+from {{name|replace('-', '_')}}._version import __version__
+from {{name|replace('-', '_')}}._version import __author__

templates/_version.py.jj2

@@ -0,0 +1,2 @@
+__version__ = '{{version}}'
+__author__ = '{{author}}'

templates/docs/source/conf.py.jj2

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+{%block additional_imports%}
+{%endblock%}
+DESCRIPTION = (
+{% for i in range(0, description|length, 70) %}
+    '{{ description[i:(70+i)] }}' +
+{% endfor %}
+    ''
+)
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+{%block SPHINX_EXTENSIONS%}
+{%endblock%}
+]
+
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+
+project = u'{{name}}'
+copyright = u'{{copyright_year}} {{company}}'
+version = '{{release}}'
+release = '{{version}}'
+exclude_patterns = []
+pygments_style = 'sphinx'
+{%block custom_doc_theme%}
+html_theme = 'default'
+{%endblock%}
+html_static_path = ['_static']
+htmlhelp_basename = '{{name}}doc'
+latex_elements = {}
+latex_documents = [
+    ('index', '{{name}}.tex',
+     '{{name}} Documentation',
+     '{{company}}', 'manual'),
+]
+man_pages = [
+    ('index', '{{name}}',
+     '{{name}} Documentation',
+     [u'{{company}}'], 1)
+]
+texinfo_documents = [
+    ('index', '{{name}}',
+     '{{name}} Documentation',
+     '{{company}}', '{{name}}',
+     DESCRIPTION,
+     'Miscellaneous'),
+]

templates/installation.rst.jj2

@@ -0,0 +1,17 @@
+{% if release != '0.0.0' %}
+
+You can install it via pip:
+
+.. code-block:: bash
+
+    $ pip install {{name}}
+
+
+or clone it and install it:
+{% endif %}
+
+.. code-block:: bash
+
+    $ git clone http://github.com/{{organisation}}/{{name}}.git
+    $ cd {{name}}
+    $ python setup.py install

templates/requirements.txt.jj2

@@ -0,0 +1,3 @@
+{% for dependency in dependencies: %}
+{{dependency}}
+{% endfor %}

templates/setup.py.jj2

@@ -1,15 +1,13 @@
 {% block header %}
+# Template by setupmobans
 {% endblock %}
+import os
 import codecs
+from shutil import rmtree
 {% if external_module_library %}
 from distutils.core import setup, Extension
 {% else %}
-try:
-    from setuptools import setup, find_packages
-except ImportError:
-    from ez_setup import use_setuptools
-    use_setuptools()
-    from setuptools import setup, find_packages
+from setuptools import setup, find_packages, Command
 {%endif%}
 {%block platform_block%}
 from platform import python_implementation
@@ -124,6 +122,42 @@ EXTRAS_REQUIRE = {
 EXTRAS_REQUIRE = {}
 {% endif %}
 {% endif %}
+PUBLISH_COMMAND = '{0} setup.py sdist bdist_wheel upload -r pypi'.format(
+    sys.executable)
+GS_COMMAND = ('gs {{name}} v{{release}} ' +
+              "Find {{release}} in changelog for more details")
+here = os.path.abspath(os.path.dirname(__file__))
+
+
+class PublishCommand(Command):
+    """Support setup.py upload."""
+
+    description = 'Build and publish the package on github and pypi'
+    user_options = []
+
+    @staticmethod
+    def status(s):
+        """Prints things in bold."""
+        print('\033[1m{0}\033[0m'.format(s))
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        try:
+            self.status('Removing previous builds…')
+            rmtree(os.path.join(here, 'dist'))
+        except OSError:
+            pass
+
+        self.status('Building Source and Wheel (universal) distribution…')
+        if os.system(GS_COMMAND) == 0:
+            os.system(PUBLISH_COMMAND)
+
+        sys.exit()
 
 
 def read_files(*files):
@@ -196,5 +230,9 @@ if __name__ == '__main__':
         entry_points=ENTRY_POINTS,
 {% endif %}
 {% endif%}
-        classifiers=CLASSIFIERS
+        classifiers=CLASSIFIERS,
+        setup_requires=['gease'],
+        cmdclass={
+            'publish': PublishCommand,
+        }
     )