From 7216b8a5b97d0f1be0f092a3a09effa4efb49de3 Mon Sep 17 00:00:00 2001 From: Roman Mogilatov Date: Mon, 30 Mar 2015 00:46:48 +0300 Subject: [PATCH] Adding Objects introduction --- README.md | 30 ++++++++++++++++++++++++++++-- objects/__init__.py | 5 ++++- setup.py | 21 +++++++++++---------- 3 files changed, 43 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d12430e7..6d124cd7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Objects ======= -Python catalogs of objects providers +Dependency management tool for Python projects. [![Latest Version](https://pypip.in/version/Objects/badge.svg)](https://pypi.python.org/pypi/Objects/) [![Downloads](https://pypip.in/download/Objects/badge.svg)](https://pypi.python.org/pypi/Objects/) @@ -11,7 +11,33 @@ Python catalogs of objects providers [![Supported Python versions](https://pypip.in/py_versions/Objects/badge.svg)](https://pypi.python.org/pypi/Objects/) [![Supported Python implementations](https://pypip.in/implementation/Objects/badge.svg)](https://pypi.python.org/pypi/Objects/) -Example: +Introduction +------------ + +Python ecosystem consists of a big amount of various classes, functions and +objects that could be used for applications development. Each of them has its +own role. + +Modern Python applications are mostly the composition of well-known open +source systems, frameworks, libraries and some turnkey functionality. + +When application goes bigger, an amount of objects and dependencies in it also +increased extremely fast and became hard to maintain. + +`Objects` is designed to be developer's friendly tool for managing objects +and their dependencies in formal, pretty way. Main idea of `Objects` is to +keep dependencies of Python projects under control. + +Entities +-------- + +- Providers are strategies of accessing to objects. +- Injections are additional instructions, that are used for determining objects +dependencies. +- Catalogs are named set of providers. + +Example +------- ```python """Concept example of `Objects`.""" diff --git a/objects/__init__.py b/objects/__init__.py index 1486e968..b6d6d6bb 100644 --- a/objects/__init__.py +++ b/objects/__init__.py @@ -1,4 +1,7 @@ -"""Objects.""" +"""Objects. + +Dependency management tool for Python projects. +""" from .catalog import AbstractCatalog from .catalog import override diff --git a/setup.py b/setup.py index 5eb50a30..0946aa08 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ if __name__ == '__main__': setup( name='Objects', version=version, - description='Python catalogs of objects providers', + description='Dependency management tool for Python projects', long_description=description, author='Roman Mogilatov', author_email='rmogilatov@gmail.com', @@ -40,15 +40,16 @@ if __name__ == '__main__': packages=['objects'], zip_safe=True, install_requires=requirements, - # keywords=['Dependency injection', - # 'Dependency injection container', - # 'DI', - # 'DIC', - # 'Dependency injector', - # 'Inversion of Control', - # 'Inversion of Control container', - # 'IoC', - # 'IoC container'], + keywords=['Dependency management', + 'Dependency injection', + 'Dependency injection container', + 'DI', + 'DIC', + 'Dependency injector', + 'Inversion of Control', + 'Inversion of Control container', + 'IoC', + 'IoC container'], classifiers=[ 'Development Status :: 3 - Alpha', 'Intended Audience :: Developers',