From 0e57f9f8445b7691c93cee2081a3abdca4cd5ca7 Mon Sep 17 00:00:00 2001 From: chfw Date: Thu, 6 Apr 2017 22:54:21 +0100 Subject: [PATCH] update documentation --- .moban.d/README.rst.jj2 | 8 +++++++- CHANGELOG.rst | 5 +++++ README.rst | 8 +++++++- docs/source/conf.py | 2 +- lml.yml | 5 ++--- requirements.txt | 1 - setup.py | 6 ++---- 7 files changed, 24 insertions(+), 11 deletions(-) diff --git a/.moban.d/README.rst.jj2 b/.moban.d/README.rst.jj2 index f9516d4..c8d1f09 100644 --- a/.moban.d/README.rst.jj2 +++ b/.moban.d/README.rst.jj2 @@ -1,5 +1,5 @@ ================================================================================ -{{name}} +{{name}} - {{description}} ================================================================================ .. image:: https://api.travis-ci.org/{{organisation}}/{{name}}.svg?branch=master @@ -13,6 +13,12 @@ :target: http://{{name|lower}}.readthedocs.org/en/latest/ {%endblock%} +**name** automatically load plugins that extend the main component from your +python environment, which could be your virtual environment, PyInstaller +environment. Its main feature is lazy loading. There could be hundreds of +plugins in your python environment but only a handful of plugins are loaded +when they are really needed. + Installation ================================================================================ diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7398c8c..6289cd7 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,2 +1,7 @@ Change log =========== + +0.0.1 - unreleased +-------------------------------------------------------------------------------- + +Initial commit diff --git a/README.rst b/README.rst index 412adc1..4fe667d 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ ================================================================================ -lml +lml - Load me later. A lazy loading plugin management system. ================================================================================ .. image:: https://api.travis-ci.org/chfw/lml.svg?branch=master @@ -11,6 +11,12 @@ lml .. image:: https://readthedocs.org/projects/lml/badge/?version=latest :target: http://lml.readthedocs.org/en/latest/ +**name** automatically load plugins that extend the main component from your +python environment, which could be your virtual environment, PyInstaller +environment. Its main feature is lazy loading. There could be hundreds of +plugins in your python environment but only a handful of plugins are loaded +when they are really needed. + Installation ================================================================================ diff --git a/docs/source/conf.py b/docs/source/conf.py index 6634ad9..5bfb379 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- DESCRIPTION = ( - 'Plugin first, Load me later' + + 'Load me later. A lazy loading plugin management system.' + '' ) extensions = [ diff --git a/lml.yml b/lml.yml index 50bc0da..1f7e1b4 100644 --- a/lml.yml +++ b/lml.yml @@ -7,6 +7,5 @@ version: "0.0.1" release: "0.0.1" copyright_year: 2017 license: New BSD -dependencies: - - six -description: "Plugin first, Load me later" \ No newline at end of file +dependencies: [] +description: "Load me later. A lazy loading plugin management system." \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index ffe2fce..e69de29 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +0,0 @@ -six diff --git a/setup.py b/setup.py index 482f538..da0d2ab 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ VERSION = '0.0.1' EMAIL = 'wangc_2011(@)hotmail.com' LICENSE = 'New BSD' DESCRIPTION = ( - 'Plugin first, Load me later' + + 'Load me later. A lazy loading plugin management system.' + '' ) KEYWORDS = [ @@ -32,13 +32,11 @@ CLASSIFIERS = [ ] INSTALL_REQUIRES = [ - 'six', ] PACKAGES = find_packages(exclude=['ez_setup', 'examples', 'tests']) -EXTRAS_REQUIRE = { -} +EXTRAS_REQUIRE = {} def read_files(*files):