Merge pull request #3 from cfhamlet/develop

ref: rename the project name

Author: cfhamlet

.coveragerc

@@ -1,9 +1,9 @@
 [run]
 parallel = true
 branch = true
-source = os_3m_engine
+source = os_m3_engine
 
 [paths]
 source =
-    src/os_3m_engine
-    .tox/*/lib/python*/site-packages/os_3m_engine
+    src/os_m3_engine
+    .tox/*/lib/python*/site-packages/os_m3_engine

.travis.yml

@@ -21,7 +21,7 @@ deploy:
   provider: pypi
   user: cfhamlet
   password:
-    secure: eL8ptaVhcvilnSvCFlETjDlBFUL0ecbLjN8BWGwRBkjDcYqHPOze/E9sff0sdDBjiyiQbKu7MD554xAfSn8FsqlQLuQfVqT8RbgSKs2vdmwjOHwCENlINY4fmk+HCtvjWnK8r2hxWB87pxQOZ6Uqb4tYizRpQtOFxNEO9QlfjRRz/M4M6fjzO7BWybEUlxnPQn9IHXP+eGoSdHVg63d4EBmh7CcNCR4/lG7OSo89fJ0IjgWgDHv2P5vHOGeiZW7gc1jiHPeppc3vtCUfwLZ2D6bAps65zv/8jpgnzIiKz+XPtzzkcxMG9ZydN1vLMRFKHp+w2uPWXFn3BHxQ0ImQ5uW5hbyT9I7LehtWkdkEZhiyKTTfCUltns8lsSVG+w74SAHPUHyVj09msWvYioHx5gVKqSKzteEek/dZGxTBi6S1ifaMs4mWyqs2wCvcMkPGlLVCdGuO0soYqxXj4HmMQ0Fq9l4Bo4tRXZNjcshNO8Dje3MSTP6eO2XCnOf547D5/X3cZ6MqBPjZnqv6bg/qZFrxathJEXfqcHseWPUM4eTBEGu/69QRSEE72cx0Gmzo9HW18RQE1O/7+/Gn/rzKkGj7S/JrR3fYZVUj4AQnxroq2qgBYsW7R348jJHDq0EVRwzvRrVpUDrzIOHpdlJRBiZ6mtEObBRdrYlWRhFbuBM=
+    secure: UyRk0TWj/RARDioa5+o8VlNTojY3hvYT9ILHi7Twnxl3f9EX/9gAuxNr7A5hGfklwQD3TrAd/mS8NyvulJj1xAWEPG4XDfeqlqAjQO8ziZEn6Ozqd/aSyCjVu6WPDluxj4kjxsXebmmDcdtX206FVgdqsG6DoT3ZZ54SeRIsuBCS2A+IlXqj4vpkKwOWhI3CGeygV4GFtOjQIRQbfejPMht1hMv/eFIXdp1fNgXpzA38JwBa40Z3vyHX5QLNLT0ShL3c0D9KRkRbrBG29kcjyUdcOwp1Hb+WUCSw1oar3fEqLabbQtw8zxPD2IDl/teygCmUGC0ldqHM6y6FeF38UPsdcXiOwyh6BjQ6ezba8vw68Moe5sacoROBkApn0JqSKsFKSqKAatQEyfgHEvjWpJklQZXC7ikq4yd5TsGoZq0DHbPFot35zFYWFKDaq92k+I/rEPoly87gfQVa6OXI7IsCzo/WvTNwA9H9xd/guu3re/yOCLoc/5NTJZZotPdRuJaMwWNNY8Y9h03vvG0uxEMw1Sp4drmclkJvFZ41F8iGzrY1Yh2lZ4kSiQ5Zuy4Iij7fLkb7es44lcUIbnNPakn0tgDYw3utGeKi08fmvuvsK91SD8d8jIdZjPnS3W3CdZ0Bi1yTnblK6Z4GQOT4mSx9vzYH05X2rGXM6TkFHV8=
   true:
     tags: true
     condition: ${TOXENV} == py27

MANIFEST.in

@@ -2,7 +2,7 @@ include LICENSE
 include README.md
 include MANIFEST.in
 include requirements.txt
-include src/os_3m_engine/VERSION
+include src/os_m3_engine/VERSION
 graft src
 graft tests
 global-exclude __pycache__

README.md

@@ -1,9 +1,9 @@
-# os-3m-engine
+# os-m3-engine
 
-[![Build Status](https://www.travis-ci.org/cfhamlet/os-3m-engine.svg?branch=master)](https://www.travis-ci.org/cfhamlet/os-3m-engine)
-[![codecov](https://codecov.io/gh/cfhamlet/os-3m-engine/branch/master/graph/badge.svg)](https://codecov.io/gh/cfhamlet/os-3m-engine)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/os-3m-engine.svg)](https://pypi.python.org/pypi/os-3m-engine)
-[![PyPI](https://img.shields.io/pypi/v/os-3m-engine.svg)](https://pypi.python.org/pypi/os-3m-engine)
+[![Build Status](https://www.travis-ci.org/cfhamlet/os-m3-engine.svg?branch=master)](https://www.travis-ci.org/cfhamlet/os-m3-engine)
+[![codecov](https://codecov.io/gh/cfhamlet/os-m3-engine/branch/master/graph/badge.svg)](https://codecov.io/gh/cfhamlet/os-m3-engine)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/os-m3-engine.svg)](https://pypi.python.org/pypi/os-m3-engine)
+[![PyPI](https://img.shields.io/pypi/v/os-m3-engine.svg)](https://pypi.python.org/pypi/os-m3-engine)
 
 Multi-thread engine for 3(or 2) stages job.
 
@@ -31,34 +31,34 @@ Something else need to know:
 
 # Install
 
-`pip install os-3m-engine`
+`pip install os-m3-engine`
 
 # API
 
 * Create default engine, a typical 3-stage job:
 
-    - frontend: ``os_3m_engine.ootb.StdinFrontend``, read from stdin, send to transport stage
-    - transport: ``os_3m_engine.ootb.LogTransport``, log data received from fronted, send to backend stage
-    - backend: ``os_3m_engine.ootb.LogBackend``, log data received from transport
+    - frontend: ``os_m3_engine.ootb.StdinFrontend``, read from stdin, send to transport stage
+    - transport: ``os_m3_engine.ootb.LogTransport``, log data received from fronted, send to backend stage
+    - backend: ``os_m3_engine.ootb.LogBackend``, log data received from transport
 
     ```
-    from os_3m_engine.launcher import create
+    from os_m3_engine.launcher import create
     
     engine = create()
     ```
 
 * Create engine with custom defined stage:
 
     ```
-    from os_3m_engine.launcher import create
+    from os_m3_engine.launcher import create
     
     engine = create(transport_cls='transport_class_path_or_class')
     ```
 
 * Create engine with custom engine config:
 
     ```
-    from os_3m_engine.launcher import create
+    from os_m3_engine.launcher import create
     
     config = WhateverOjbectYouWant
     config.thread_num = 10
@@ -77,7 +77,7 @@ Something else need to know:
 
     ```
     from signal
-    from os_3m_engine.launcher import create
+    from os_m3_engine.launcher import create
     
     engine = create()
     
@@ -91,11 +91,11 @@ Something else need to know:
     
 * Custom frontend class:
 
-    - inherit from ``os_3m_engine.core.frontend.Frontend``
+    - inherit from ``os_m3_engine.core.frontend.Frontend``
     - define ``produce`` method as generator
 
     ```
-    from os_3m_engine.core.frontend import Frontend
+    from os_m3_engine.core.frontend import Frontend
     
     class CustomFrontend(Frontend):
         def produce(self):
@@ -104,11 +104,11 @@ Something else need to know:
     
 * Custom transport class:
 
-    - inherit from ``os_3m_engine.core.transport.Transport``
+    - inherit from ``os_m3_engine.core.transport.Transport``
     - define ``transport`` method, the only parameter is the data received, the return value will be sent to backend
 
     ```
-    from os_3m_engine.core.transport import Transport
+    from os_m3_engine.core.transport import Transport
     
     class CustomTransport(Transport):
         def transport(self, data):
@@ -117,11 +117,11 @@ Something else need to know:
 
 * Custom backend class:
 
-    - inherit from ``os_3m_engine.core.backend.Backend``
+    - inherit from ``os_m3_engine.core.backend.Backend``
     - define ``process`` method, the only parameter is the data received, no need return
 
     ```
-    from os_3m_engine.core.backend import Backend
+    from os_m3_engine.core.backend import Backend
     
     class CustomBackend(Backend):
         def process(self, data):
@@ -134,7 +134,7 @@ Something else need to know:
     - use ``self.config`` to get the config in stage class
 
     ```
-    from os_3m_engine.launcher import create
+    from os_m3_engine.launcher import create
     
     config = WhateverOjbectYouWant
     engine = create(app_config=config)
@@ -148,7 +148,7 @@ Something else need to know:
     
     
     ```
-    from os_3m_engine.core.backend import Backend
+    from os_m3_engine.core.backend import Backend
     
     class CustomBackend(Backend):
     

setup.py

@@ -14,8 +14,8 @@ def read(*filenames, **kwargs):
 
 
 setup(
-    name='os-3m-engine',
-    version=read('src/os_3m_engine/VERSION'),
+    name='os-m3-engine',
+    version=read('src/os_m3_engine/VERSION'),
     packages=find_packages(where='src'),
     package_dir={'': 'src'},
     include_package_data=True,
@@ -24,7 +24,7 @@ def read(*filenames, **kwargs):
     long_description=open('README.md').read(),
     author='Ozzy',
     author_email='cfhamlet@gmail.com',
-    url='https://github.com/cfhamlet/os-3m-engine',
+    url='https://github.com/cfhamlet/os-m3-engine',
     install_requires=open('requirements.txt').read().split('\n'),
     zip_safe=False,
     classifiers=[

src/os_3m_engine/VERSION renamed to src/os_m3_engine/VERSION

@@ -6,29 +6,29 @@
 from .utils import load_class
 
 ENGINE_FRONTEND_CONFIG = Config.create(
-    thread_cls='os_3m_engine.core.frontend.FrontendThread',
+    thread_cls='os_m3_engine.core.frontend.FrontendThread',
     thread_num=1,
-    driver_cls='os_3m_engine.core.frontend.FrontendDriver',
-    component_factory_cls='os_3m_engine.common.ComponentFactory',
+    driver_cls='os_m3_engine.core.frontend.FrontendDriver',
+    component_factory_cls='os_m3_engine.common.ComponentFactory',
     queue_size=100,
 )
 
 ENGINE_TRANSPORT_CONFIG = Config.create(
-    thread_cls='os_3m_engine.core.transport.TransportThread',
+    thread_cls='os_m3_engine.core.transport.TransportThread',
     thread_num=3,
-    driver_cls='os_3m_engine.core.transport.TransportDriver',
-    component_factory_cls='os_3m_engine.common.ComponentFactory',
+    driver_cls='os_m3_engine.core.transport.TransportDriver',
+    component_factory_cls='os_m3_engine.common.ComponentFactory',
 )
 
 ENGINE_TRANSPORT_BRIDGE_CONFIG = Config.create()
 ENGINE_TRANSPORT_BRIDGE_CONFIG.update(ENGINE_TRANSPORT_CONFIG)
-ENGINE_TRANSPORT_BRIDGE_CONFIG.driver_cls = 'os_3m_engine.core.transport.BridgeDriver'
+ENGINE_TRANSPORT_BRIDGE_CONFIG.driver_cls = 'os_m3_engine.core.transport.BridgeDriver'
 
 ENGINE_BACKEND_CONFIG = Config.create(
-    thread_cls='os_3m_engine.core.backend.BackendThread',
+    thread_cls='os_m3_engine.core.backend.BackendThread',
     thread_num=1,
-    driver_cls='os_3m_engine.core.backend.BackendDriver',
-    component_factory_cls='os_3m_engine.common.ComponentFactory',
+    driver_cls='os_m3_engine.core.backend.BackendDriver',
+    component_factory_cls='os_m3_engine.common.ComponentFactory',
     queue_size=100,
 )
 
@@ -56,9 +56,9 @@ def combine_with_default_config(default_config, custom_config):
     return c
 
 
-def create(frontend_cls='os_3m_engine.ootb.StdinFrontend',
-           transport_cls='os_3m_engine.ootb.LogTransport',
-           backend_cls='os_3m_engine.ootb.LogBackend',
+def create(frontend_cls='os_m3_engine.ootb.StdinFrontend',
+           transport_cls='os_m3_engine.ootb.LogTransport',
+           backend_cls='os_m3_engine.ootb.LogBackend',
            app_config=None,
            engine_config=ENGINE_CONFIG,
            engine_frontend_config=ENGINE_FRONTEND_CONFIG,

src/os_3m_engine/__init__.py renamed to src/os_m3_engine/__init__.py

@@ -1,7 +1,7 @@
 import time
-from os_3m_engine.core.backend import Backend
-from os_3m_engine.core.frontend import Frontend
-from os_3m_engine.core.transport import Transport
+from os_m3_engine.core.backend import Backend
+from os_m3_engine.core.frontend import Frontend
+from os_m3_engine.core.transport import Transport
 
 DATA = 'Hello World!'
 

src/os_3m_engine/common.py renamed to src/os_m3_engine/common.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from os_3m_engine.launcher import create
+from os_m3_engine.launcher import create
 
 
 @pytest.fixture(scope='function')

src/os_3m_engine/core/__init__.py renamed to src/os_m3_engine/core/__init__.py

@@ -1,7 +1,7 @@
 import pytest
 
-from os_3m_engine.core.engine import RuntimeContext
-from os_3m_engine.launcher import create
+from os_m3_engine.core.engine import RuntimeContext
+from os_m3_engine.launcher import create
 
 
 @pytest.fixture(scope='function')

src/os_3m_engine/core/backend.py renamed to src/os_m3_engine/core/backend.py

@@ -2,7 +2,7 @@
 
 
 def test_getatters():
-    from os_3m_engine.utils import getatters
+    from os_m3_engine.utils import getatters
 
     class T(object):
         pass
@@ -12,18 +12,18 @@ class T(object):
 
 
 def test_load_class():
-    from os_3m_engine.utils import load_class
-    from os_3m_engine.core.engine import Engine
+    from os_m3_engine.utils import load_class
+    from os_m3_engine.core.engine import Engine
     assert Engine == load_class(
-        'os_3m_engine.core.engine.Engine', Engine, True)
+        'os_m3_engine.core.engine.Engine', Engine, True)
 
-    from os_3m_engine.common import Configurable
-    from os_3m_engine.common import Component
-    assert Component == load_class('os_3m_engine.common.Component')
+    from os_m3_engine.common import Configurable
+    from os_m3_engine.common import Component
+    assert Component == load_class('os_m3_engine.common.Component')
 
-    assert None == load_class('os_3m_engine.NotExist')
+    assert None == load_class('os_m3_engine.NotExist')
 
-    assert None == load_class('os_3m_engine.common.Component', Engine)
+    assert None == load_class('os_m3_engine.common.Component', Engine)
 
     with pytest.raises(ImportError):
         load_class('not_exist.What')