Minor fixes and update documentation. Preparing the upcoming 0.2 release.
This commit is contained in:
14
docs/guide/ext/docker.rst
Normal file
14
docs/guide/ext/docker.rst
Normal file
@ -0,0 +1,14 @@
|
||||
Bonobo with Docker
|
||||
==================
|
||||
|
||||
.. todo:: The `bonobo-docker` package is at a very alpha stage, and things will change. This section is here to give a
|
||||
brief overview but is neither complete nor definitive.
|
||||
|
||||
Installation
|
||||
::::::::::::
|
||||
|
||||
Overview
|
||||
::::::::
|
||||
|
||||
Details
|
||||
:::::::
|
||||
11
docs/guide/ext/jupyter.rst
Normal file
11
docs/guide/ext/jupyter.rst
Normal file
@ -0,0 +1,11 @@
|
||||
Bonobo with Jupyter
|
||||
==================
|
||||
|
||||
Installation
|
||||
::::::::::::
|
||||
|
||||
Overview
|
||||
::::::::
|
||||
|
||||
Details
|
||||
:::::::
|
||||
@ -1,8 +1,9 @@
|
||||
Web crawlers with Bonobo
|
||||
========================
|
||||
Bonobo with Selenium
|
||||
====================
|
||||
|
||||
.. todo:: The `bonobo-selenium` package is at a very alpha stage, and things will change. This section is here to give a
|
||||
brief overview but is neither complete nor definitive.
|
||||
|
||||
.. todo:: Bonobo-Selenium is at a very alpha stage, and things will change. This section is here to give a brief
|
||||
overview but is neither complete nor definitive.
|
||||
|
||||
Writing web crawlers with Bonobo and Selenium is easy.
|
||||
|
||||
@ -31,3 +32,11 @@ Where each step would do the following:
|
||||
* `details()` extract the data you're interested in.
|
||||
* ... and the writer saves it somewhere.
|
||||
|
||||
Installation
|
||||
::::::::::::
|
||||
|
||||
Overview
|
||||
::::::::
|
||||
|
||||
Details
|
||||
:::::::
|
||||
15
docs/guide/ext/sqlalchemy.rst
Normal file
15
docs/guide/ext/sqlalchemy.rst
Normal file
@ -0,0 +1,15 @@
|
||||
Bonobo with SQLAlchemy
|
||||
======================
|
||||
|
||||
.. todo:: The `bonobo-sqlalchemy` package is at a very alpha stage, and things will change. This section is here to
|
||||
give a brief overview but is neither complete nor definitive.
|
||||
|
||||
|
||||
Installation
|
||||
::::::::::::
|
||||
|
||||
Overview
|
||||
::::::::
|
||||
|
||||
Details
|
||||
:::::::
|
||||
@ -1,8 +1,25 @@
|
||||
Guides
|
||||
======
|
||||
|
||||
Concepts and best practices
|
||||
:::::::::::::::::::::::::::
|
||||
|
||||
There are a few things that you should know while writing transformations graphs with bonobo.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
purity
|
||||
crawlers
|
||||
|
||||
Third party integrations
|
||||
::::::::::::::::::::::::
|
||||
|
||||
There is a few **bonobo** extensions that ease the use of the library with third party tools. Each integration is
|
||||
available as an optional extra dependency, and the maturity stage of each extension vary.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
ext/docker
|
||||
ext/selenium
|
||||
ext/sqlalchemy
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
Pure components and space complexity
|
||||
====================================
|
||||
Pure transformations
|
||||
====================
|
||||
|
||||
The nature of components, and how the data flow from one to another, make them not so easy to write correctly.
|
||||
Hopefully, with a few hints, you will be able to understand why and how they should be written.
|
||||
@ -14,7 +14,7 @@ returning) them. Numeric values, strings and tuples being immutable in python, m
|
||||
type will already return a different instance.
|
||||
|
||||
Numbers
|
||||
=======
|
||||
:::::::
|
||||
|
||||
You can't be wrong with numbers. All of the following are correct.
|
||||
|
||||
@ -45,7 +45,7 @@ You can't be wrong with numbers. All of the following are correct.
|
||||
The same is true with other numeric types, so don't be shy. Operate like crazy, my friend.
|
||||
|
||||
Tuples
|
||||
======
|
||||
::::::
|
||||
|
||||
Tuples are immutable, so you risk nothing.
|
||||
|
||||
@ -63,12 +63,12 @@ Tuples are immutable, so you risk nothing.
|
||||
return t
|
||||
|
||||
Strings
|
||||
=======
|
||||
:::::::
|
||||
|
||||
You know the drill, strings are immutable, blablabla ... Examples left as an exercise for the reader.
|
||||
|
||||
Dicts
|
||||
=====
|
||||
:::::
|
||||
|
||||
So, now it gets interesting. Dicts are mutable. It means that you can mess things up badly here if you're not cautious.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user