Go to file
Christophe Siraut c6acb91c26 debian: update changelog 2019-02-13 12:30:31 +01:00
.moban.d :eggs: 🎡 release 0.0.5 2018-11-06 18:31:45 +00:00
debian debian: update changelog 2019-02-13 12:30:31 +01:00
docs 💄 pump up the version number 2019-01-07 07:21:31 +00:00
examples 🔨 code refactoring and 📚 update change log 2018-11-06 18:14:24 +00:00
lml utils.py: Fix typo 2019-01-15 00:42:46 +05:30
tests 🔨 #11 add more content of tests folder 2019-01-07 07:13:29 +00:00
.gitignore initial commit 2017-04-04 08:53:11 +01:00
.isort.cfg 🔨 code refactoring and 📚 update change log 2018-11-06 18:14:24 +00:00
.moban.yml 🔨 add tests and docs for package validation. resolve #9 2019-01-04 12:04:09 +00:00
.travis.yml 🔥 remove 3.4 so as to speed up the travis ci test. 5 co-current node is the open source limit of travis. 2019-01-07 07:27:19 +00:00
CHANGELOG.rst 💄 pump up the version number 2019-01-07 07:21:31 +00:00
LICENSE release 0.0.1 2017-05-30 23:17:10 +01:00
MANIFEST.in 🔨 #11 add more content of tests folder 2019-01-07 07:13:29 +00:00
Makefile 🔨 major automatic code formatting using isort and black 2018-11-05 22:36:27 +00:00
README.rst 📚 update project description 2018-06-12 23:28:41 +01:00
changelog.yml 💄 pump up the version number 2019-01-07 07:21:31 +00:00
lml.yml 💄 pump up the version number 2019-01-07 07:21:31 +00:00
requirements.txt update documentation 2017-04-06 22:54:21 +01:00
rnd_requirements.txt minor update 2017-04-18 22:15:23 +01:00
setup.cfg minor touch 2017-05-30 09:06:07 +01:00
setup.py 💄 pump up the version number 2019-01-07 07:21:31 +00:00
test.sh 🔥 ignore docs folder for style checking 2018-11-06 18:16:51 +00:00

README.rst

================================================================================
lml - Load me later. A lazy plugin management system.
================================================================================

.. image:: https://api.travis-ci.org/chfw/lml.svg
   :target: http://travis-ci.org/chfw/lml

.. image:: https://codecov.io/github/chfw/lml/coverage.png
   :target: https://codecov.io/github/chfw/lml


.. image:: https://readthedocs.org/projects/lml/badge/?version=latest
   :target: http://lml.readthedocs.org/en/latest/

**lml** seamlessly finds the lml based plugins from your current python
environment but loads your plugins on demand. It is designed to support
plugins that have external dependencies, especially bulky and/or
memory hungry ones. lml provides the plugin management system only and the
plugin interface is on your shoulder.

**lml** enabled applications helps your customers [#f1]_ in two ways:

#. Your customers could cherry-pick the plugins from pypi per python environment.
   They could remove a plugin using `pip uninstall` command.
#. Only the plugins used at runtime gets loaded into computer memory.

When you would use **lml** to refactor your existing code, it aims to flatten the
complexity and to shrink the size of your bulky python library by
distributing the similar functionalities across its plugins. However, you as
the developer need to do the code refactoring by yourself and lml would lend you a hand.

.. [#f1] the end developers who uses your library and packages achieve their
         objectives.

Installation
================================================================================


You can install lml via pip:

.. code-block:: bash

    $ pip install lml


or clone it and install it:

.. code-block:: bash

    $ git clone https://github.com/chfw/lml.git
    $ cd lml
    $ python setup.py install

License
================================================================================

New BSD