From 4b24c480150b06a690634c95f34875414a166a58 Mon Sep 17 00:00:00 2001 From: BJ Dierkes Date: Sat, 28 Apr 2018 12:58:45 -0500 Subject: [PATCH] Update README / Setuptools Description --- README.md | 53 +++++++++++++++++++++++++---------------------------- setup.py | 17 +++++------------ 2 files changed, 30 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 6eab6610..14035f26 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Cement Framework -================ +# Cement Framework Cement is an advanced CLI Application Framework for Python. Its goal is to introduce a standard, and feature-full platform for both simple and complex @@ -18,22 +17,22 @@ command line and backend application development. Cement core features include (but are not limited to): - * Core pieces of the framework are customizable via handlers/interfaces - * Extension handler interface to easily extend framework functionality - * Config handler supports parsing multiple config files into one config - * Argument handler parses command line arguments and merges with config - * Log handler supports console and file logging - * Plugin handler provides an interface to easily extend your application - * Hook support adds a bit of magic to apps and also ties into framework - * Handler system connects implementation classes with Interfaces - * Output handler interface renders return dictionaries to console - * Cache handler interface adds caching support for improved performance - * Controller handler supports sub-commands, and nested controllers - * Zero external dependencies* (not including optional extensions) - * 100% test coverage using `nose` and `coverage` - * 100% PEP8 and style compliant using `flake8` - * Extensive Sphinx documentation - * Tested on Python 2.6, 2.7, 3.3, 3.4, and 3.5 +- Core pieces of the framework are customizable via handlers/interfaces +- Extension handler interface to easily extend framework functionality +- Config handler supports parsing multiple config files into one config +- Argument handler parses command line arguments and merges with config +- Log handler supports console and file logging +- Plugin handler provides an interface to easily extend your application +- Hook support adds a bit of magic to apps and also ties into framework +- Handler system connects implementation classes with Interfaces +- Output handler interface renders return dictionaries to console +- Cache handler interface adds caching support for improved performance +- Controller handler supports sub-commands, and nested controllers +- Zero external dependencies* (not including optional extensions) +- 100% test coverage using `nose` and `coverage` +- 100% PEP8 and style compliant using `flake8` +- Extensive Sphinx documentation +- Tested on Python 2.6, 2.7, 3.3, 3.4, and 3.5 *Note that argparse is required as an external dependency for Python < 2.7 and < 3.2. Additionally, some optional extensions that are shipped with the @@ -42,19 +41,17 @@ responsibility of the application developer to include these dependencies along with their application, as Cement explicitly does not include them.* -More Information ----------------- +## More Information - * DOCS: http://builtoncement.com/2.10/ - * CODE: http://github.com/datafolklabs/cement/ - * PYPI: http://pypi.python.org/pypi/cement/ - * SITE: http://builtoncement.com/ - * T-CI: https://travis-ci.org/datafolklabs/cement - * HELP: cement@librelist.org - #cement - gitter.im/datafolklabs/cement +- [Developer & API Documentation]](http://builtoncement.com/2.10/) +- [Source Code / Issue Tracking](http://github.com/datafolklabs/cement/) +- [Installation Packages on PyPi](http://pypi.python.org/pypi/cement/) +- [Website](http://builtoncement.com/) +- [Travis Continuous Integration Testing](https://travis-ci.org/datafolklabs/cement) +- [Slack Channel](https://join.slack.com/t/cementframework/shared_invite/enQtMzUzOTIzMDQwNjEwLThkY2FiYWU5ZmQ5ZmEzNGMzMTkyMDgzNTk2MWI0MGU1YWNmNTVmODgxYWNlZjJkZDBmODc0ZjM2MDg5ZmYyOTA) -License -------- +## License The Cement CLI Application Framework is Open Source and is distributed under the BSD License (three clause). Please see the LICENSE file included with diff --git a/setup.py b/setup.py index d1318e7d..72aa36ee 100644 --- a/setup.py +++ b/setup.py @@ -5,17 +5,9 @@ from cement.utils import version VERSION = version.get_version() -LONG = """ -Cement is an advanced CLI Application Framework for Python. Its goal is to -introduce a standard, and feature-full platform for both simple and complex -command line applications as well as support rapid development needs without -sacrificing quality. - -For more information please visit the official site at: - - * http://builtoncement.com/ - -""" +f = open('README.md', 'r') +LONG = f.read() +f.close() DEPS = [ ### Required to build documentation @@ -34,11 +26,12 @@ setup(name='cement', version=VERSION, description="CLI Application Framework for Python", long_description=LONG, + long_description_content_type='text/markdown', classifiers=[], keywords='cli framework', author='Data Folk Labs, LLC', author_email='team@datafolklabs.com', - url='http://builtoncement.org', + url='http://builtoncement.com', license='BSD', packages=find_packages(exclude=['ez_setup', 'tests*']), include_package_data=True,