version 0.1.0

.gitignore

@@ -7,6 +7,7 @@ __pycache__/
 *.so
 
 # Distribution / packaging
+.idea
 .Python
 env/
 build/

AUTHORS.rst

@@ -1,3 +1,7 @@
+==========
+AUTHORS
+==========
+
 Finchan is written and maintained by qytz and
 various contributors:
 

CHANGES.rst

@@ -2,7 +2,7 @@
 History
 =======
 
-0.0.1 (2017-02-23)
+0.1.0 (2018-09-22)
 ------------------
 
 * First release on PyPI.

Pipfile

@@ -0,0 +1,15 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+click = "*"
+uvloop = "*"
+python-dateutil = "*"
+"ruamel.yaml" = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.6"

README.rst

@@ -18,7 +18,7 @@ finchan
      :alt: Updates
 
 
-financial test tools with python.
+Finchan event process framework with python.
 
 
 * Free software: Apache License 2.0
@@ -28,4 +28,4 @@ financial test tools with python.
 Features
 --------
 
-* TODO
+Do whatever you want with it.

docs/Makefile

@@ -4,9 +4,9 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = finchan
-SOURCEDIR     = source
-BUILDDIR      = build
+SPHINXPROJ    = Finchan
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.rst

@@ -0,0 +1,11 @@
+APIS
+======
+
+.. toctree::
+    event
+    event_source
+    kvstore
+    env
+    dispatcher
+    ext_manager
+    timer_source

docs/arch.rst

@@ -0,0 +1,47 @@
+=========================
+system architecture
+=========================
+Finchan is a event system framework,
+its main modules are `Event`, `EventSource`, `Dispatcher`, `Subscribers`, `env` and `ExtManager`.
+
+concept
+=====================
+
+The :class:`Event <finchan.event.Event>` is the input manner for `finchan`.
+
+The :class:`EventSource <finchan.interface.event_source.AbsEventSource>`
+is the original input for the system, it simulate the real world's things to `Event` as input.
+
+The :class:`Dispatcher <finchan.dispatcher.LiveDispatcher>` is the engine of the system,
+it manage all `EventSource`, all event `Subscriber`,
+and dispath the events generated by `EventSource` or `Subscriber`, call the `Subscriber`'s callback.
+
+The `Subscriber` is event subscriber, it subscriber event with a callback function,
+when the event occurs, the `Dispatcher` dispatch the event and call the callback function.
+The `Subscriber` can do anything with the callback function, include generate new events.
+
+The :class:`env <finchan.env.Env>` is global environment for the system,
+you can access it just by `from finchan.env import env`,
+you can access environment variable setted by other modules, or set your own environment variable.
+
+the :class:`ExtManager <finchan.exts.ExtManager>` manage all extensions for `finchan`.
+
+Interfaces
+================
+
+kvstore
+----------------
+:class:`kvstore <finchan.interface.kvstore.AbsKvStore>` is persistent storage for finchan,
+`finchan` framework just specified the interface for kvstore,
+the implemention is done by extensions.
+
+EventSource
+----------------
+The :class:`EventSource <finchan.interface.event_source.AbsEventSource>` defines the interface to
+implent an EventSource, `finchan` system include a :any:`TimerSource <finchan.exts.timer_source>`,
+if you need other EventSource, you should write an extension for `finchan`,
+or check `finchan_exts <https://github.com/qytz/finchan_exts>`_ first.
+
+Write an extension for finchan
+==================================
+refer :doc:`extend`.

docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst

docs/source/conf.py → docs/conf.py

@@ -19,16 +19,25 @@
 #
 import os
 import sys
-# sys.path.insert(0, os.path.abspath('.'))
-cwd = os.getcwd()
-doc_root = os.path.dirname(cwd)
-project_root = os.path.dirname(doc_root)
-sys.path.insert(0, project_root)
+sys.path.insert(0, os.path.abspath(".."))
 
-import finchan
+from finchan.__version__ import __version__ as finchan_version
 
 
-# -- General configuration ------------------------------------------------
+# General information about the project.
+project = 'Finchan'
+copyright = '2017-present, qytz'
+author = 'qytz'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = finchan_version
+# The full version, including alpha/beta/rc tags.
+release = finchan_version
+
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
@@ -38,9 +47,11 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.coverage',
     'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
-    'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode']
 
@@ -56,20 +67,6 @@
 # The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
-project = 'finchan'
-copyright = '2017, qytz'
-author = 'qytz'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = finchan.__version__
-# The full version, including alpha/beta/rc tags.
-release = finchan.__version__
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
@@ -80,7 +77,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = []
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -91,10 +88,12 @@
 
 # -- Options for HTML output ----------------------------------------------
 
+# html_favicon = 'favicon.ico'
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+# html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -107,6 +106,16 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
 
 # -- Options for HTMLHelp output ------------------------------------------
 
@@ -187,3 +196,34 @@
 epub_exclude_files = ['search.html']
 
 
+
+# -- Extension configuration -------------------------------------------------
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3.6/', None),
+    # 'dateutil': ('https://dateutil.readthedocs.io/', None),
+}
+
+primary_domain = 'py'
+default_role = 'py:obj'
+
+autodoc_member_order = "bysource"
+autoclass_content = "both"
+autodoc_inherit_docstrings = False
+
+# Without this line sphinx includes a copy of object.__init__'s docstring
+# on any class that doesn't define __init__.
+# https://bitbucket.org/birkenfeld/sphinx/issue/1337/autoclass_content-both-uses-object__init__
+autodoc_docstring_signature = False
+
+coverage_skip_undoc_in_source = True
+coverage_ignore_modules = []
+# I wish this could go in a per-module file...
+coverage_ignore_classes = []
+
+coverage_ignore_functions = [
+    # various modules
+    "doctests",
+    "main",
+]
+

docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst

docs/dispatcher.rst

@@ -0,0 +1,19 @@
+finchan.dispatcher
+======================
+
+.. automodule:: finchan.dispatcher
+
+   Dispatcher
+   --------------------
+   .. autoclass:: BaseDispatcher
+       :members:
+
+   BackTrackDispatcher
+   --------------------
+   .. autoclass:: BackTrackDispatcher
+       :members:
+
+   LiveDispatcher
+   --------------------
+   .. autoclass:: LiveDispatcher
+       :members: