Skip to content

Commit

Permalink
v2.0.7: minor doc and travis fixes
Browse files Browse the repository at this point in the history 
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
  • Loading branch information
@Kwpolska
Kwpolska committed Jul 13, 2016
1 parent 36312f6 commit 0653f6e
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 211 deletions.
56 changes: 30 additions & 26 deletions CHANGELOG.rst
View file
Expand Up @@ -5,8 +5,8 @@ PyPT Changelog
:Author: Chris Warrick <chris@chriswarrick.com>
:Copyright: © 2013-2016, Chris Warrick.
:License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
:Date: 2016-04-29
:Version: 2.0.6
:Date: 2016-07-13
:Version: 2.0.7

.. index:: CHANGELOG

Expand All @@ -19,39 +19,43 @@ More information can be found on GitHub in the `releases section
Version History
===============

v2.0.6
2.0.7
* Make some minor changes to CHANGELOG.txt
* Use Python 3.5 in Travis

2.0.6
* Sign releases commits and tags
* Use new PyPI URL scheme in PKGBUILDs
* Use correct file name for coverage exclude
* Use repo name for gettext domain
* Experimental support for PyQt5 in ``localegen``

v2.0.5
2.0.5
* Put test setup in ``setup.cfg``
* More modern ``setup.py`` (uses ``package_data`` and ``find_packages()``, does not use
``requirements.txt``, removes support for ``./setup.py test``)
* Sample hook for AUR updates
* Fixes to tests and ``localegen``
* Move Qt addons to ``pypt-extras/`` directory

v2.0.4
2.0.4
* Split out wildcard removal that may fail so that other cleanup works fine
* Don’t remove the ``dist`` directory

v2.0.3
2.0.3
* Update dates to 2016

v2.0.2
2.0.2
* Add ``post-release.hook`` (at the very end, perfect for “Next steps” messages)

v2.0.1
2.0.1
* ``MAINFEST.in`` file
* Minor bugfixes

v2.0.0
2.0.0
* Automation (using cookiecutter)

v1.3.1
1.3.1

.. code:: text
Expand All @@ -63,67 +67,67 @@ v1.3.1
` -+- -------------- -+- '
'-:-' '-:-'
v1.3.0
1.3.0
* Use ``argparse`` in ``commitlog`` and ``ghrel`` instead of a ``sys.argv`` hack
* Vendor ``textwrap.indent`` in ``commitlog`` for Python 2 compatibility
* Use ``py.test`` in the ``release`` script
* Run tests only if they exist
* Create and upload wheels


v1.2.1
1.2.1
* Use new tests in .travis.yml.


v1.2.0
1.2.0
* Better tests, stored in a directory and using py.test instead of unittest.


v1.1.2
1.1.2
* Add ``.pypt/PYPT-UPDATE`` script (copy it somewhere else and customize to your liking)


v1.1.1
1.1.1
* Fix ``$cmfn`` variables in ``./release``
* Print correct release URL (``html_url`` for friendly webpage)
* Support Transifex in locale generation (``-tx`` suffix)


v1.1.0
1.1.0
* Automate GitHub Releases posting. (For CMFN-based files, ``backticks`` are automatically corrected.)

v1.0.9
1.0.9
* Fix mismatched paths in the commit and changelog editor (cmfn) — requries update of ``.pypt/commitlog`` and ``release``
* PEP 257 compliance

v1.0.8
1.0.8
* Update Sphinx ``version`` field (previously, only ``release`` was updated)

v1.0.7
1.0.7
* no more AUR uploads due to AURv4

v1.0.6
1.0.6
* Use ``twine`` instead of ``setup.py upload``
* Fix ``aursend`` path

v1.0.5
1.0.5
Updating all dates to say 2015.

v1.0.4
1.0.4
* Rebranding: removing nickname from all *Author* lines.

v1.0.3
1.0.3
* changed e-mail address
* setup.cfg
* setuptools entry_points
* py.test

v1.0.2
1.0.2
* Set the © fields to 2014.

v1.0.1
1.0.1
* Some small changes and fixes.

v1.0.0
1.0.0
* Initial release.

4 changes: 2 additions & 2 deletions README.rst
View file
Expand Up @@ -4,8 +4,8 @@ Python Project Template. INSERT TAGLINE HERE.™
:Info: This is the README file for the Python Project Template.
:Author: Chris Warrick <chris@chriswarrick.com>
:Copyright: © 2013-2016, Chris Warrick.
:Date: 2016-04-29
:Version: 2.0.6
:Date: 2016-07-13
:Version: 2.0.7

.. index: README
.. image:: https://travis-ci.org/Kwpolska/python-project-template.svg?branch=master
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.repo_name}}/.pypt/commitlog
View file
Expand Up @@ -80,7 +80,7 @@ def main():
parser.add_argument('basedir', metavar='BASEDIR', nargs=1,
help='Project directory')
parser.add_argument('new_version', metavar='NEWVERSION', nargs=1,
help='New version (vX.Y.Z)')
help='New version (X.Y.Z)')
args = parser.parse_args()
# nargs gets you lists, not strings
filename = args.filename[0]
Expand Down
1 change: 1 addition & 0 deletions {{cookiecutter.repo_name}}/.travis.yml
View file
Expand Up @@ -4,6 +4,7 @@ python:
- "2.7"
- "3.3"
- "3.4"
- "3.5"
- "pypy"

install:
Expand Down
105 changes: 14 additions & 91 deletions {{cookiecutter.repo_name}}/CONTRIBUTING.rst
View file
Expand Up @@ -2,11 +2,8 @@
Appendix A. Contribution rules
==============================
:Info: Those are the contribution rules for {{ cookiecutter.project_name }}.
:Author: {{ cookiecutter.full_name }} <{{ cookiecutter.email }}>
:Copyright: © {{ cookiecutter.year }}, {{ cookiecutter.full_name }}.
:License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
:Date: {{ cookiecutter.release_date }}
:Version: {{ cookiecutter.version }}
:Copyright: © 2012-2016, Chris Warrick.
:License: 3-clause BSD

.. index:: contributing

Expand All @@ -27,10 +24,9 @@ Issue reporting
GitHub Issues are the recommended way to report an issue. If you do not have an
account there, get one or mail me.

When pasting console sessions, you must paste them fully,
*prompt-to-prompt*, to see all the messages and your input.
Trim only stuff that you are 1000% sure that is not related
to the project in question.
When pasting console sessions, you must paste them fully, *prompt-to-prompt*,
to see all the messages and your input. Trim only stuff that you are 1000%
sure that is not related to the project in question.

--------------------------------------------
General preparations, rules and pull process
Expand All @@ -39,24 +35,24 @@ General preparations, rules and pull process
Prepare
=======

A GitHub account is recommended. Patches by mail are accepted, but working
with you through there is a better way.

Fork the repo first. Non-GitHub people, ``git clone``.
A GitHub account is recommended. Patches by mail are accepted, but I’d prefer
to work via GitHub.

.. _Rules:

Rules
=====

1. Commits must have short, informative and logical messages. Signoffs and
long messages are recommended. “fixes #xxx” is required if an issue
long messages are recommended. “Fix #xxx” is required if an issue
exists.
2. The following fancy Unicode characters should be used when
needed: ``— “ ” ‘ ’``
3. The ellipsis (``…``) character must not be used in program output for
humans, but may be used elsewhere.
4. I’m a Grammar Nazi.
needed: ``— “ ” ‘ ’``. ``…`` should not appear in console output, but may
appear elsewhere.
3. For Python code, use the PEP 8 coding style and PEP 257 documentation style.
For other languages, K&R style applies. Braces are mandatory in all blocks
(even one-line blocks). Braces are on the same lines as class names and
function signatures. Use 4-space indents.

Request a Pull
==============
Expand All @@ -66,76 +62,3 @@ use GitHub, ``git format-patch``. Other formats are not accepted.

Your commit should be pulled up in a (longer) while. If I like it. Because
some commits may be bad. So, do your best not to do those bad commits.

---------------------------------------
Details for specific contribution types
---------------------------------------

Code (Python)
=============

1. PEP 8. ``pip install pep8`` is recommended.
2. ``./tests.py``.
3. Localize all the strings (``_('string')``)
4. Strings must be quoted using ``'str'``. Multi-line strings, ``"""str"""``.
Use the latter only if needed. Otherwise, do:

.. code-block:: python
:linenos:
string = ('A very, very, very long string '
'that’s broken up into multiple lines.')
string = _('A very, very, very log string '
'that’s broken up into multiple lines '
'and that is localized through gettext.'))
5. ``str.format``. Braces should be empty or contain a name that is later
passed on to the function. The format function should be inserted *after*
the parenthesis for string localization. For example:

.. code-block:: python
:linenos:
string = _('{} is awesome').format('PKGBUILDer')
string = _('{sth} is awesome').format(sth='PKGBUILDer')
6. Documentation is important. Please take care of it.

Code (non-Python)
=================

Rejected.

Non-code contributions
======================

Those are accepted. No specific rules exist. And don’t remove any files
without my permission (``docs/*.8.gz`` in particular).

Localization
============

.. index:: locale

1. Run ``mkdir -p locale/[CODE]/LC_MESSAGES`` in your terminal, replacing
``[CODE]`` by your language code, as in /usr/share/locale.
2. Copy the ``/messages.pot`` file to
``locale/[CODE]/LC_MESSAGES/[PROJECT].po`` (replace ``[PROJECT]`` with the
project name, all-lowercase)
3. Do your work. The comments will inform you where this string is, and the
ones starting with 'TRANSLATORS:' are for you to read and make use of.
Other comments come from my code and you should not care about them. And
if it is directed for translators, let me know. The Poedit_ app may be
of help. Please take care of the headers at the top of the file (with a
text editor, do not use Poedit for that!) and modify them. The
Last-Translator, Language-Team and Language are important, the others are
auto-generated anyways. The general :ref:`Rules` apply, please take care
of it!
4. Commit (``-s/--signoff`` is required here).
5. Your translation will be added in the next release, or, if a release isn’t
planned in the near future, a new release will be made. Your addition will
be appreciated. Note that I cannot translate new strings, and, as a result,
I might ask you for additions in the future.

.. _Poedit: http://www.poedit.net/

0 comments on commit 0653f6e

Please sign in to comment.