Permalink
Browse files

Issue #9: Add supporting documentation to track the project history.

-  Rename README.markdown to README.rst.
-  Add AUTHORS.rst with brief note on their contributions.
-  Add CHANGELOG.rst with detailed change documentation.
-  Add CONTRIBUTING.rst with detailed guidelines for pull requests.
-  Fix MANIFEST to include these new files.
-  Ensure setup uses the README.rst for `long_description`.
  • Loading branch information...
1 parent 750767a commit 701c40b2a23d438c438de5f3b7dd8d7be5f5f4e4 @lakshmivyas lakshmivyas committed Feb 19, 2013
Showing with 166 additions and 18 deletions.
  1. +30 −0 AUTHORS.rst
  2. +53 −0 CHANGELOG.rst
  3. +46 −0 CONTRIBUTING.rst
  4. +1 −1 LICENSE
  5. +4 −1 MANIFEST.in
  6. +25 −14 README.markdown → README.rst
  7. +0 −1 commando/conf.py
  8. +7 −1 setup.py
View
@@ -0,0 +1,30 @@
+-------------------------
+Authors
+-------------------------
+
+* `Lakshmi Vyas`_
+
+ - Maintainer.
+
+* `Brandon Philips`_
+
+ - Clean up packaging issues.
+
+ * Use ``distribute`` to peek into the package to get the issue number.
+ {38e21c48680873fc7409effb654c0c733024e9e1}.
+
+ * Get ``install_requires`` from the ``requirements.txt`` file.
+ {d8b29fa3fe2f0bdeeda91c445a9aea38b8fa5b70}.
+
+* `Ben West`_
+
+ - Allow parameterless subcommands and commands. (Pull #4).
+
+* `Julien Danjou`_
+
+ - Support for nested subcommands. (Pull #7)
+
+.. _Lakshmi Vyas: https://github.com/lakshmivyas
+.. _Brandon Philips: https://github.com/philips
+.. _Ben West: https://github.com/bewest
+.. _Julien Danjou: https://github.com/jd
View
@@ -0,0 +1,53 @@
+Version 0.3a
+--------------
+
+Thanks to `Julien Danjou`_ :
+
+- Add support for nested sub commands.
+ {0e26a6fe2571accb78d26318ab1b8dc65636d2b0}. (Pull #7)
+
+Version 0.2.1a
+--------------
+
+Thanks to `Ben West`_ :
+
+- Allow commands to have no params.
+
+Version 0.2a
+--------------
+
+- Bundle various frequently used utilities with commando.
+ (``ShellCommand``, ``ConfigDict``, ``autoprop`` and logging helpers).
+ {63525646bb366f4def3c5065a51a404b18269873}. (Pull #4)
+
+
+Version 0.1.3a
+--------------
+
+- Commando must consume exceptions by default. Any exception should be
+ communicated in a friendly manner to the user via the parser or the
+ given logger. {0e26a6fe2571accb78d26318ab1b8dc65636d2b0}.
+
+Version 0.1.2a
+---------------
+
+Thanks to `Brandon Philips`_ :
+
+- Use ``distribute_setup.py``.
+- Derive version from ``pkg_resources``.
+- Add ``argparse`` as a dependency.
+
+Version 0.1.1a
+---------------
+
+- Add more decorators that map to argparse parameters.
+
+Version 0.1a
+------------
+
+- Create a simple meta programmed wrapper around ``argparse``.
+
+.. _Lakshmi Vyas: https://github.com/lakshmivyas
+.. _Brandon Philips: https://github.com/philips
+.. _Ben West: https://github.com/bewest
+.. _Julien Danjou: https://github.com/jd
View
@@ -0,0 +1,46 @@
+**tl;dr** Good (code + tests + commit message) = Great Pull Request.
+
+*****************************************************************************
+
+How do the pull requests get merged?
+------------------------------------
+
+The following points are considered as part of merging pull requests after
+it is deemed necessary.
+
+1. Is there an issue tagged in the commit?
+2. Do the existing tests pass?
+3. Are there new tests added to verify any new functionality / issue?
+4. Is the authors list up to date?
+5. Is the changelog updated?
+6. Is the version updated?
+7. Does this require any changes to the documentation?
+
+Guidelines
+-----------
+
+If the following guidelines are observed as much as possible, it will
+immensely help in verifying and merging the pull requests.
+
+1. One pull request = One feature or One bug.
+2. Always tag an issue in the commit. If an issue does
+ not exist for a feature or a bug, please add one.
+3. Use topic / feature branches.
+4. Make sure a test exists to verify the committed code. A
+ good way to think about it is: if these commits were reversed
+ and only the test were added back in, it ought to fail.
+5. Make the `commit message`_ as verbose as possible.
+6. Add yourself to `Authors`_ list and update your contribution.
+7. Cross update `Changelog`_ list as well.
+8. Update ``version.py`` and ``README.rst`` with a version in this format:
+ <version>-<yourusername><issuenumber>.
+9. If the change was complicated and resulted in a lot of commits,
+ consider ``rebase -i`` to sqash and/or rearrange them to make it easier
+ to review.
+10. Update the `Readme`_.
+
+
+.. _commit message: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+.. _Changelog: CHANGELOG.rst
+.. _Authors: AUTHORS.rst
+.. _Readme: README.rst
View
@@ -1,6 +1,6 @@
The MIT License
-Copyright (c) 2010 Lakshmi Vyasarajan, Ringce.com
+Copyright (c) 2010-2013 Lakshmi Vyasarajan, Ringce.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
View
@@ -4,4 +4,7 @@ include distribute_setup.py
recursive-include commando *.py
recursive-include commando/tests *.py *.txt
include LICENSE
-include README.markdown
+include README.rst
+include AUTHORS.rst
+include CHANGELOG.rst
+include CONTRIBUTING.rst
@@ -1,18 +1,21 @@
-# commando - argparse in style
+============================
+commando - argparse in style
+============================
-Version 0.3a
+**Version 0.3a**
-A simple wrapper for `argparse` that allows commands and arguments
+A simple wrapper for ``argparse`` that allows commands and arguments
to be defined declaratively using decorators. Note that this does
-not support all the features of `argparse` yet.
+not support all the features of ``argparse`` yet.
-Commando also bundles a few utilities that are essential for command
-line applications.
+Commando also bundles a few utilities that are useful when building
+command line applications.
-## Example
+Example
+--------
+Without commando::
-### Without commando:
def main():
parser = argparse.ArgumentParser(description='hyde - a python static website generator',
@@ -36,7 +39,7 @@ line applications.
print params.overwrite
-### With commando
+With commando::
class Engine(Application):
@@ -57,9 +60,17 @@ line applications.
print params.template
print params.overwrite
-## Authors
+Resources
+---------
+
+1. `Changelog`_
+2. `License`_
+3. `Contributing`_
+4. `Authors`_
+
+
+.. _Changelog: CHANGELOG.rst
+.. _LICENSE: LICENSE
+.. _Contributing: CONTRIBUTING.rst
+.. _Authors: AUTHORS.rst
-* [Lakshmi Vyas](https://github.com/lakshmivyas)
-* [Brandon Philips](https://github.com/philips)
-* [Ben West](https://github.com/bewest)
-* [Julien Danjou](https://github.com/jd)
View
@@ -2,7 +2,6 @@
seqs = (tuple, list, set, frozenset)
-
class ConfigDict(defaultdict):
def __init__(self, initial=None):
super(ConfigDict, self).__init__(ConfigDict)
View
@@ -2,10 +2,16 @@
use_setuptools()
from setuptools import setup
+try:
+ long_description = open('README.rst', 'rt').read()
+except IOError:
+ long_description = ''
+
+
setup(
name='commando',
description='A declarative interface to argparse with additional utilities',
- long_description='Adds decorators that allow subcommands to be defined as simple functions',
+ long_description=long_description,
version='0.3a',

0 comments on commit 701c40b

Please sign in to comment.