Merge pull request #33 from jayvdb/badges-scm

More scm_host support and gitter_room and mention @coala

Author: chfw

.moban.dt/local-README.rst.jj2

@@ -0,0 +1,49 @@
+{% extends 'README.rst.jj2' %}
+
+{% block documentation_link %}
+{% endblock %}
+
+{% block features %}
+{{description}}
+It is used with `yehua <https://github.com/chfw/yehua>`_.
+Organisations using it:
+
+- `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+- `coala <https://github.com/coala/coala>`_.
+
+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
+{% endblock %}
+
+{% block bottom_block %}
+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 to configure `gease`.
+{% endblock %}

README.rst

@@ -5,8 +5,19 @@ pypi-mobans
 .. image:: https://api.travis-ci.org/moremoban/pypi-mobans.svg?branch=master
    :target: http://travis-ci.org/moremoban/pypi-mobans
 
-Scaffolding templates for your Python project. It is used with `yehua <https://github.com/chfw/yehua>`_
-and `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+.. image:: https://codecov.io/github/moremoban/pypi-mobans/coverage.png
+   :target: https://codecov.io/github/moremoban/pypi-mobans
+
+.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
+   :target: https://gitter.im/chfw_moban/Lobby
+
+
+Scaffolding templates for your Python project.
+It is used with `yehua <https://github.com/chfw/yehua>`_.
+Organisations using it:
+
+- `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+- `coala <https://github.com/coala/coala>`_.
 
 Features
 ================================================================================
@@ -31,8 +42,8 @@ You can get it:
 
 .. code-block:: bash
 
-    $ git clone http://github.com/moremoban/pypi-mobans.git
-
+    $ git clone https://github.com/moremoban/pypi-mobans.git
+    $ cd pypi-mobans
 
 Notes
 ================================================================================
@@ -50,4 +61,4 @@ your home folder as::
    password=your_password
 
 
-And you need to configure `gease`. 
+And you need to configure `gease`.

config/data.yml

@@ -8,4 +8,7 @@ contact: [email protected]
 license: NEW BSD
 company: Onni Software Ltd.
 branch: master
-description: this is a base for python project scaffolding
+description: Scaffolding templates for your Python project.
+release: 0.0.0
+gitter_room: chfw_moban/Lobby
+setup_py: false

local.yml

@@ -1,7 +1,9 @@
 configuration:
   configuration: config/data.yml
   template_dir:
+    - .moban.dt/
     - templates
 targets:
   - .gitignore: gitignore.jj2
   - LICENSE: NEW_BSD_LICENSE.jj2
+  - README.rst: local-README.rst.jj2

templates/README.rst.jj2

@@ -5,11 +5,7 @@
 {%endif%}
 ================================================================================
 
-.. image:: https://api.travis-ci.org/{{organisation}}/{{name}}.svg?branch=master
-   :target: http://travis-ci.org/{{organisation}}/{{name}}
-
-.. image:: https://codecov.io/gh/{{organisation}}/{{name}}/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/{{organisation}}/{{name}}
+{% include 'badges.rst.jj2' %}
 
 {%block documentation_link%}
 .. image:: https://readthedocs.org/projects/{{name|lower}}/badge/?version=latest
@@ -25,4 +21,4 @@ Installation
 {% include "installation.rst.jj2" %}
 
 {%block bottom_block%}
-{%endblock%}
+{%endblock%}

templates/badges.rst.jj2

@@ -1,8 +1,20 @@
+{% if not scm_host %}
+{% set scm_host = 'github.com' %}
+{% endif %}
+{% if scm_host == 'github.com' %}
 .. image:: https://api.travis-ci.org/{{organisation}}/{{name}}.svg?branch={{branch}}
    :target: http://travis-ci.org/{{organisation}}/{{name}}
+{% endif %}
 
+{% if scm_host == 'github.com' %}
 .. image:: https://codecov.io/github/{{organisation}}/{{name}}/coverage.png
    :target: https://codecov.io/github/{{organisation}}/{{name}}
+{% elif scm_host == 'gitlab.com' %}
+.. image:: https://codecov.io/gitlab/{{organisation}}/{{name}}/coverage.png
+   :target: https://codecov.io/gitlab/{{organisation}}/{{name}}
+{% endif %}
 
+{% if gitter_room %}
 .. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
-   :target: https://gitter.im/pyexcel/Lobby
+   :target: https://gitter.im/{{gitter_room}}
+{% endif %}

templates/installation.rst.jj2

@@ -1,3 +1,6 @@
+{% if not scm_host %}
+{% set scm_host = 'github.com' %}
+{% endif %}
 {% if release != '0.0.0' %}
 
 You can install {{name}} via pip:
@@ -8,10 +11,14 @@ You can install {{name}} via pip:
 
 
 or clone it and install it:
+{% else %}
+You can get it:
 {% endif %}
 
 .. code-block:: bash
 
-    $ git clone https://github.com/{{organisation}}/{{name}}.git
+    $ git clone https://{{scm_host}}/{{organisation}}/{{name}}.git
     $ cd {{name}}
+{% if setup_py != False %}
     $ python setup.py install
+{% endif %}