diff options
| -rw-r--r-- | .gitignore | 4 | ||||
| -rwxr-xr-x | README.rst | 3 | ||||
| -rw-r--r-- | docs/alternatives.rst | 12 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rwxr-xr-x | setup.py | 86 |
6 files changed, 66 insertions, 49 deletions
@@ -4,4 +4,6 @@ dist cmd2.egg-info .idea .cache -*.pyc
\ No newline at end of file +*.pyc +.coverage +htmlcov @@ -10,6 +10,9 @@ cmd2 :target: https://ci.appveyor.com/project/FedericoCeratto/cmd2
:alt: Appveyor build status
+.. image:: https://readthedocs.org/projects/cmd2/badge/?version=latest
+ :target: https://cmd2.readthedocs.io
+
.. image:: https://img.shields.io/pypi/dm/cmd2.svg?style=plastic
:target: https://pypi.python.org/pypi/cmd2/
:alt: Downloads
diff --git a/docs/alternatives.rst b/docs/alternatives.rst index bbf2ae2e..f55bec51 100644 --- a/docs/alternatives.rst +++ b/docs/alternatives.rst @@ -2,8 +2,8 @@ Alternatives to cmd and cmd2 ============================ -For programs that do not interact with the user in a continuous loop - -programs that simply accept a set of arguments from the command line, return +For programs that do not interact with the user in a continuous loop - +programs that simply accept a set of arguments from the command line, return results, and do not keep the user within the program's environment - all you need are sys_\ .argv (the command-line arguments) and optparse_ (for parsing UNIX-style options and flags). @@ -23,7 +23,7 @@ cursor keys. However, programming a curses_-based application is not as straightforward as using cmd_. Several packages in PyPI enable interactive command-line applications -approximately similar in concept to cmd_ applications. None of them +approximately similar in concept to cmd_ applications. None of them share cmd2's close ties to cmd, but they may be worth investigating nonetheless. @@ -31,7 +31,7 @@ nonetheless. * cly_ * CmDO_ (As of Feb. 2010, webpage is missing.) * pycopia-CLI_ - + cmdln_, another package in PyPI, is an extension to cmd_ and, though it doesn't retain full cmd_ compatibility, shares its basic structure with cmd_. @@ -44,7 +44,7 @@ cmd_. .. _CmDO: http://pypi.python.org/pypi/CmDO/0.7 -.. _pycopia-CLI: http://pypi.python.org/pypi/pycopia-CLI/1.0 +.. _pycopia-CLI: https://github.com/kdart/pycopia/tree/master/CLI -I've found several alternatives to cmd in the Cheese Shop - CmdLoop, cly, CMdO, and pycopia. cly looks wonderful, but I haven't been able to get it working under Windows, and that's a show-stopper for many potential sqlpython users. In any case, none of the alternatives are based on cmd - they're written from scratch, which means that a cmd-based app would need complete rewriting to use them. I like sticking close to the Standard Library whenever possible. cmd2 lets you do that. +I've found several alternatives to cmd in PyPI - CmdLoop, cly, CMdO, and pycopia. cly looks wonderful, but I haven't been able to get it working under Windows, and that's a show-stopper for many potential sqlpython users. In any case, none of the alternatives are based on cmd - they're written from scratch, which means that a cmd-based app would need complete rewriting to use them. I like sticking close to the Standard Library whenever possible. cmd2 lets you do that. diff --git a/docs/conf.py b/docs/conf.py index 32d9243c..5a0e7c1a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,9 +45,9 @@ copyright = u'2010, Catherine Devlin' # built documents. # # The short X.Y version. -version = '0.6' +version = '0.7' # The full version, including alpha/beta/rc tags. -release = '0.6.9a' +release = '0.7.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index f98ebb4a..ca5e8870 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,8 +10,8 @@ A python package for building powerful command-line interpreter (CLI) programs. Extends the Python Standard Library's cmd_ package. -.. _`cmd2 project page`: https://bitbucket.org/catherinedevlin/cmd2 -.. _`project bug tracker`: https://bitbucket.org/catherinedevlin/cmd2/issues +.. _`cmd2 project page`: https://github.com/python-cmd2/cmd2 +.. _`project bug tracker`: https://github.com/python-cmd2/cmd2/issues .. _cmd: http://docs.python.org/library/cmd.html#module-cmd @@ -60,7 +60,7 @@ Contents: Compatibility ============= -Tested and working with Python 2.7, 3.5, 3.6 +Tested and working with Python 2.7 and 3.3+. Indices and tables ================== @@ -1,27 +1,18 @@ #!/usr/bin/python # coding=utf-8 +""" +Setuptools setup file, used to install or test 'cmd2' +""" from setuptools import setup -install_requires = ['pyparsing >= 2.0.1', 'six'] +VERSION = '0.7.0' +DESCRIPTION = "Extra features for standard library's cmd module" -tests_require = ['mock', 'pytest'] +LONG_DESCRIPTION = """cmd2 is an enhancement to the standard library's cmd module for Python 2.7 +and Python 3.3+. It is pure Python code with dependencies only on the six and pyparsing modules. -setup( - name="cmd2", - version="0.7.0", - py_modules=["cmd2"], - use_2to3=False, - - # metadata for upload to PyPI - author='Catherine Devlin', - author_email='catherine.devlin@gmail.com', - description="Extra features for standard library's cmd module", - license='MIT', - keywords='command prompt console cmd', - url='http://packages.python.org/cmd2/', - install_requires=install_requires, - tests_require=tests_require, - long_description="""Enhancements for standard library's cmd module. +The latest documentation for cmd2 can be read online here: +https://cmd2.readthedocs.io/ Drop-in replacement adds several features for command-prompt tools: @@ -40,24 +31,45 @@ Drop-in replacement adds several features for command-prompt tools: * test apps against sample session transcript (see example/example.py) Useable without modification anywhere cmd is used; simply import cmd2.Cmd in place of cmd.Cmd. +""" -See docs at http://packages.python.org/cmd2/ -""", - - classifiers=[ - 'Development Status :: 4 - Beta', - 'Environment :: Console', - 'Operating System :: OS Independent', - 'Intended Audience :: Developers', - 'Intended Audience :: System Administrators', - 'Programming Language :: Python', - 'License :: OSI Approved :: MIT License', - 'Topic :: Software Development :: Libraries :: Python Modules', - 'Programming Language :: Python :: 2.7', - 'Programming Language :: Python :: 3.3', - 'Programming Language :: Python :: 3.4', - 'Programming Language :: Python :: 3.5', - 'Programming Language :: Python :: 3.6', - ], -) +CLASSIFIERS = filter(None, map(str.strip, + """ + Development Status :: 5 - Production/Stable + Environment :: Console + Operating System :: OS Independent + Intended Audience :: Developers + Intended Audience :: System Administrators + License :: OSI Approved :: MIT License + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.3 + Programming Language :: Python :: 3.4 + Programming Language :: Python :: 3.5 + Programming Language :: Python :: 3.6 + Programming Language :: Python :: Implementation :: CPython + Programming Language :: Python :: Implementation :: PyPy + Topic :: Software Development :: Libraries :: Python Modules + """.splitlines())) +INSTALL_REQUIRES = ['pyparsing >= 2.0.1', 'six'] +TESTS_REQUIRE = ['mock', 'pytest'] + +setup( + name="cmd2", + version=VERSION, + description=DESCRIPTION, + long_description=LONG_DESCRIPTION, + classifiers=CLASSIFIERS, + author='Catherine Devlin', + author_email='catherine.devlin@gmail.com', + url='https://github.com/python-cmd2/cmd2', + license='MIT', + platforms=['any'], + py_modules=["cmd2"], + keywords='command prompt console cmd', + install_requires=INSTALL_REQUIRES, + tests_require=TESTS_REQUIRE, +) |