paulin/bonobo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor fixes and update documentation. Preparing the upcoming 0.2 release.

Browse Source
This commit is contained in:
Romain Dorgueil
2017-01-20 20:45:16 +01:00
parent e57ec4a4b3
commit 9dab39a474
67 changed files with 845 additions and 714 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/reference/api.rst Normal file
View File

@ -0,0 +1,56 @@
Public API
==========
All the "public api" callables, classes and other callables are available under the root :mod:`bonobo` package, even if
they are documented within their sub-namespace, for convenience.
.. automodule:: bonobo
:members: create_strategy, get_examples_path, run
:undoc-members:
:show-inheritance:
Config
------
.. automodule:: bonobo.config
:members:
:undoc-members:
:show-inheritance:
Context
-------
.. automodule:: bonobo.context
:members:
:undoc-members:
:show-inheritance:
Core
----
.. automodule:: bonobo.core
:members:
:undoc-members:
:show-inheritance:
IO
--
.. automodule:: bonobo.io
:members:
:undoc-members:
:show-inheritance:
Util
----
.. automodule:: bonobo.util
:members:
:undoc-members:
:show-inheritance:

22
docs/reference/bonobo.compat.rst
View File

@ -1,22 +0,0 @@
bonobo.compat package
=====================
Submodules
----------
bonobo.compat.pandas module
---------------------------
.. automodule:: bonobo.compat.pandas
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.compat
:members:
:undoc-members:
:show-inheritance:

85
docs/reference/bonobo.core.rst
View File

@ -1,85 +0,0 @@
bonobo.core package
===================
Subpackages
-----------
.. toctree::
bonobo.core.strategies
Submodules
----------
bonobo.core.bags module
-----------------------
.. automodule:: bonobo.core.bags
:members:
:undoc-members:
:show-inheritance:
bonobo.core.contexts module
---------------------------
.. automodule:: bonobo.core.contexts
:members:
:undoc-members:
:show-inheritance:
bonobo.core.errors module
-------------------------
.. automodule:: bonobo.core.errors
:members:
:undoc-members:
:show-inheritance:
bonobo.core.graphs module
-------------------------
.. automodule:: bonobo.core.graphs
:members:
:undoc-members:
:show-inheritance:
bonobo.core.inputs module
-------------------------
.. automodule:: bonobo.core.inputs
:members:
:undoc-members:
:show-inheritance:
bonobo.core.plugins module
--------------------------
.. automodule:: bonobo.core.plugins
:members:
:undoc-members:
:show-inheritance:
bonobo.core.services module
---------------------------
.. automodule:: bonobo.core.services
:members:
:undoc-members:
:show-inheritance:
bonobo.core.stats module
------------------------
.. automodule:: bonobo.core.stats
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.core
:members:
:undoc-members:
:show-inheritance:

38
docs/reference/bonobo.core.strategies.rst
View File

@ -1,38 +0,0 @@
bonobo.core.strategies package
==============================
Submodules
----------
bonobo.core.strategies.base module
----------------------------------
.. automodule:: bonobo.core.strategies.base
:members:
:undoc-members:
:show-inheritance:
bonobo.core.strategies.executor module
--------------------------------------
.. automodule:: bonobo.core.strategies.executor
:members:
:undoc-members:
:show-inheritance:
bonobo.core.strategies.naive module
-----------------------------------
.. automodule:: bonobo.core.strategies.naive
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.core.strategies
:members:
:undoc-members:
:show-inheritance:

30
docs/reference/bonobo.io.rst
View File

@ -1,30 +0,0 @@
bonobo.io package
=================
Submodules
----------
bonobo.io.file module
---------------------
.. automodule:: bonobo.io.file
:members:
:undoc-members:
:show-inheritance:
bonobo.io.json module
---------------------
.. automodule:: bonobo.io.json
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.io
:members:
:undoc-members:
:show-inheritance:

21
docs/reference/bonobo.rst
View File

@ -1,21 +0,0 @@
bonobo package
==============
Subpackages
-----------
.. toctree::
bonobo.compat
bonobo.core
bonobo.ext
bonobo.io
bonobo.util
Module contents
---------------
.. automodule:: bonobo
:members:
:undoc-members:
:show-inheritance:

62
docs/reference/bonobo.util.rst
View File

@ -1,62 +0,0 @@
bonobo.util package
===================
Submodules
----------
bonobo.util.compat module
-------------------------
.. automodule:: bonobo.util.compat
:members:
:undoc-members:
:show-inheritance:
bonobo.util.helpers module
--------------------------
.. automodule:: bonobo.util.helpers
:members:
:undoc-members:
:show-inheritance:
bonobo.util.iterators module
----------------------------
.. automodule:: bonobo.util.iterators
:members:
:undoc-members:
:show-inheritance:
bonobo.util.lifecycle module
----------------------------
.. automodule:: bonobo.util.lifecycle
:members:
:undoc-members:
:show-inheritance:
bonobo.util.time module
-----------------------
.. automodule:: bonobo.util.time
:members:
:undoc-members:
:show-inheritance:
bonobo.util.tokens module
-------------------------
.. automodule:: bonobo.util.tokens
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.util
:members:
:undoc-members:
:show-inheritance:

33
docs/reference/commands.rst Normal file
View File

@ -0,0 +1,33 @@
Commands Reference
==================
Bonobo Init
:::::::::::
Create an empty project, ready to use bonobo.
Syntax: `bonobo init`
Requires `edgy.project`.
Bonobo Run
::::::::::
Run a transformation graph.
Syntax: `bonobo run [-c cmd | -m mod | file | -] [arg]`
.. todo:: implement -m, check if -c is of any use and if yes, implement it too. Implement args, too.
Bonobo RunC
:::::::::::
Run a transformation graph in a docker container.
Syntax: `bonobo runc [-c cmd | -m mod | file | -] [arg]`
.. todo:: implement -m, check if -c is of any use and if yes, implement it too. Implement args, too.
Requires `bonobo-docker`, install with `docker` extra: `pip install bonobo[docker]`.

36
docs/reference/examples.rst Normal file
View File

@ -0,0 +1,36 @@
Examples
========
There are a few examples bundled with **bonobo**. You'll find them under the :mod:`bonobo.examples` package.
Types
:::::
bonobo.examples.types.strings
-----------------------------
.. automodule:: bonobo.examples.types.strings
:members: graph, extract, transform, load
:undoc-members:
:show-inheritance:
bonobo.examples.types.dicts
---------------------------
.. automodule:: bonobo.examples.types.dicts
:members: graph, extract, transform, load
:undoc-members:
:show-inheritance:
bonobo.examples.types.bags
--------------------------
.. automodule:: bonobo.examples.types.bags
:members: graph, extract, transform, load
:undoc-members:
:show-inheritance:

7
docs/reference/index.rst
View File

@ -6,8 +6,5 @@ References
.. toctree::
:maxdepth: 4
bonobo
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
commands
api