Skip to content

Commit

Permalink
🔬 implement README.rst using templates
Browse files Browse the repository at this point in the history
Also mention @coala uses this project.
  • Loading branch information
jayvdb committed Jun 7, 2018
1 parent 759b9c6 commit 8560a30
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 6 deletions.
49 changes: 49 additions & 0 deletions .moban.dt/local-README.rst.jj2
Original file line number Diff line number Diff line change
@@ -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 %}
21 changes: 16 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
================================================================================
Expand All @@ -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
================================================================================
Expand All @@ -50,4 +61,4 @@ your home folder as::
password=your_password


And you need to configure `gease`.
And you need to configure `gease`.
5 changes: 4 additions & 1 deletion config/data.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ contact: wangc_2011@hotmail.com
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
2 changes: 2 additions & 0 deletions local.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8560a30

Please sign in to comment.