+
diff --git a/docs/guide/purity.rst b/docs/guide/purity.rst index cf9d47f..05784c5 100644 --- a/docs/guide/purity.rst +++ b/docs/guide/purity.rst @@ -82,7 +82,7 @@ For example, doing the following may cause unexpected problems: 'foo': compute_something() }) # Still bad! Don't mutate the dict! - d['bar']: compute_anotherthing() + d['bar'] = compute_anotherthing() return d The problem is easy to understand: as **Bonobo** won't make copies of your dict, the same dict will be passed along the diff --git a/docs/history.rst b/docs/history.rst index 70eea0a..c7a8362 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -11,7 +11,7 @@ happened because of **rdc.etl**. It would have been counterproductive to migrate the same codebase: - * a lot of mistakes were impossible to fix in a backward compatible way (for example, transormations were stateful, + * a lot of mistakes were impossible to fix in a backward compatible way (for example, transformations were stateful, making them more complicated to write and impossible to reuse, a lot of effort was used to make the components have multi-inputs and multi-outputs, although in 99% of the case it's useless, etc.). * we also wanted to develop something that took advantage of modern python versions, hence the choice of 3.5+. diff --git a/docs/tutorial/tut01.rst b/docs/tutorial/tut01.rst index 6504298..d61c544 100644 --- a/docs/tutorial/tut01.rst +++ b/docs/tutorial/tut01.rst @@ -15,7 +15,7 @@ Let's write a first data transformation We'll start with the simplest transformation possible. In **Bonobo**, a transformation is a plain old python callable, not more, not less. Let's write one that takes a string -and uppercase it. +and uppercases it. .. code-block:: python @@ -68,7 +68,7 @@ Let's chain the three transformations together and run the transformation graph: } We use the :func:`bonobo.run` helper that hides the underlying object composition necessary to actually run the -transformations in parralel, because it's simpler. +transformations in parallel, because it's simpler. Depending on what you're doing, you may use the shorthand helper method, or the verbose one. Always favor the shorter, if you don't need to tune the graph or the execution strategy (see below). @@ -113,12 +113,12 @@ Concepts and definitions by yielding values (a.k.a returning a generator). * Transformation graph (or Graph): a set of transformations tied together in a :class:`bonobo.Graph` instance, which is a simple directed acyclic graph (also refered as a DAG, sometimes). -* Node: a transformation within the context of a transformation graph. The node defines what to do whith a - transformation's output, and especially what other node to feed with the output. -* Execution strategy (or strategy): a way to run a transformation graph. It's responsibility is mainly to parralelize +* Node: a transformation within the context of a transformation graph. The node defines what to do with a + transformation's output, and especially what other nodes to feed with the output. +* Execution strategy (or strategy): a way to run a transformation graph. It's responsibility is mainly to parallelize (or not) the transformations, on one or more process and/or computer, and to setup the right queuing mechanism for transformations' inputs and outputs. -* Execution context (or context): a wrapper around a node that holds the state for it. If the node need the state, there +* Execution context (or context): a wrapper around a node that holds the state for it. If the node needs state, there are tools available in bonobo to feed it to the transformation using additional call parameters, and so every transformation will be atomic. diff --git a/docs/tutorial/tut02.rst b/docs/tutorial/tut02.rst index 2ceeb55..f053c89 100644 --- a/docs/tutorial/tut02.rst +++ b/docs/tutorial/tut02.rst @@ -2,7 +2,7 @@ Working with files ================== Bonobo would not be of any use if the aim was to uppercase small lists of strings. In fact, Bonobo should not be used -if you don't expect any gain from parralelization/distribution of tasks. +if you don't expect any gain from parallelization/distribution of tasks. Let's take the following graph as an example: @@ -19,7 +19,7 @@ the :class:`bonobo.ThreadPoolExecutorStrategy`), which allows to start running ` of data, and `C` as soon as `B` yielded the first line of data, even if `A` or `B` still have data to yield. The great thing is that you generally don't have to think about it. Just be aware that your components will be run in -parralel (with the default strategy), and don't worry too much about blocking components, as they won't block their +parallel (with the default strategy), and don't worry too much about blocking components, as they won't block their siblings when run in bonobo. That being said, let's try to write a more real-world like transformation. diff --git a/setup.py b/setup.py index a9b983c..1d12879 100644 --- a/setup.py +++ b/setup.py @@ -10,9 +10,12 @@ tolines = lambda c: list(filter(None, map(lambda s: s.strip(), c.split('\n')))) def read(filename, flt=None): - with open(filename) as f: - content = f.read().strip() - return flt(content) if callable(flt) else content + try: + with open(filename) as f: + content = f.read().strip() + return flt(content) if callable(flt) else content + except EnvironmentError: + return '' # Py3 compatibility hacks, borrowed from IPython. @@ -26,8 +29,12 @@ except NameError: version_ns = {} -execfile(os.path.join(root_dir, 'bonobo/_version.py'), version_ns) -version = version_ns.get('__version__', 'dev') +try: + execfile(os.path.join(root_dir, 'bonobo/_version.py'), version_ns) +except EnvironmentError: + version = 'dev' +else: + version = version_ns.get('__version__', 'dev') setup( name='bonobo', @@ -58,8 +65,11 @@ setup( 'jupyter': ['jupyter >=1.0,<1.1', 'ipywidgets >=6.0.0.beta5'] }, entry_points={ - 'bonobo.commands': ['init = bonobo.commands.init:register', 'run = bonobo.commands.run:register'], - 'console_scripts': ['bonobo = bonobo.commands:entrypoint'], + 'bonobo.commands': [ + 'init = bonobo.commands.init:register', 'run = bonobo.commands.run:register', + 'version = bonobo.commands.version:register' + ], + 'console_scripts': ['bonobo = bonobo.commands:entrypoint', 'bb = bonobo.commands:entrypoint'], 'edgy.project.features': ['bonobo = ' 'bonobo.ext.edgy.project.feature:BonoboFeature'] },