nojhan/weboob-devel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add helloworld on index page

Browse source
This commit is contained in:
Romain Bignon 2014-08-31 15:27:51 +02:00
commit 18e9e4a779
6 changed files with 41 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/source/_templates/indexcontent.html
View file

@ -5,6 +5,44 @@
<p class="last">This is the developer documentation. If you are not a developer and you are looking for information about the project, check the <a href="http://weboob.org" class="reference external">official website</a>.</p>
</div>
<p><strong>Hello world:</strong></p>
<table class="contentstable" align="center"><tr>
<td width="50%">
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">weboob.core</span> <span class="kn">import</span> <span class="n">Weboob</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">weboob.capabilities.bank</span> <span class="kn">import</span> <span class="n">CapBank</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">w</span> <span class="o">=</span> <span class="n">Weboob</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">w</span><span class="o">.</span><span class="n">load_backends</span><span class="p">(</span><span class="n">CapBank</span><span class="p">)</span>
<span class="go">{'societegenerale': &lt;Backend 'societegenerale'&gt;, 'creditmutuel': &lt;Backend 'creditmutuel'&gt;}</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">w</span><span class="o">.</span><span class="n">iter_accounts</span><span class="p">()))</span>
<span class="go">[&lt;Account id='7418529638527412' label=u'Compte de ch\xe8ques'&gt;,</span>
<span class="go"> &lt;Account id='9876543216549871' label=u'Livret A'&gt;,</span>
<span class="go"> &lt;Account id='123456789123456789123EUR' label=u'C/C Eurocompte Confort M Roger Philibert'&gt;]</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">acc</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">w</span><span class="o">.</span><span class="n">iter_accounts</span><span class="p">()))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">acc</span><span class="o">.</span><span class="n">balance</span>
<span class="go">Decimal('87.32')</span>
</pre></div>
</div>
</td><td width="50%">
</td></tr>
</table>
<p><strong>Concepts:</strong></p>
<table class="contentstable" align="center"><tr>
<td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("api/capabilities/index") }}">Capabilities</a><br/>
<span class="linkdescr">represent features common to various websites</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("guides/module") }}">Modules</a><br/>
<span class="linkdescr">each one handles a specific website and implement capabilities</span></p>
</td><td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("api/core/index") }}">Core Library</a><br/>
<span class="linkdescr">provides all the features needed by modules</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("api/tools/application/index") }}">Applications</a><br/>
<span class="linkdescr">to call modules of a specific capability</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("api/tools/index") }}">Tools</a><br/>
<span class="linkdescr">help developing modules and applications</span></p>
</td></tr>
</table>
<p><strong>Guides:</strong></p>
<table class="contentstable" align="center"><tr>
<td width="50%">

2
docs/source/_templates/indexsidebar.html
View file

@ -3,5 +3,5 @@
<li><a href="http://weboob.org/">Official website</a></li>
<li><a href="https://symlink.me/projects/weboob/issues">Bug Tracker</a></li>
<li><a href="https://symlink.me/projects/weboob/roadmap">Roadmap</a></li>
<li><a href="https://symlink.me/projects/weboob/files">Download sources</a></li>
<li><a href="https://symlink.me/projects/weboob/files">Download stable version</a></li>
</ul>

2
docs/source/conf.py
View file

@ -36,7 +36,7 @@ source_suffix = '.rst'
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
#master_doc = 'index'
# General information about the project.
project = u'Weboob'

2
docs/source/guides/setup.rst
View file

@ -38,7 +38,7 @@ Then, run this command::
$ weboob-config update
Run Weboob without installation
------------------------------
-------------------------------
This does not actually install anything, but lets you run Weboob from the source code,
while also using the modules from that source::

26
docs/source/index.rst
View file

@ -1,26 +0,0 @@
Weboob
======
Weboob (Web Outside Of Browsers) provides:
* :doc:`applications <api/tools/application/index>` to interact with websites
* :doc:`modules </guides/module>`, each one handles a specific website
* a :doc:`core library <api/core/index>` providing all the features needed by backends
* :doc:`tools <api/tools/index>` to help develop backends and applications
Weboob is written in Python and is distributed under the AGPLv3+ license.
.. note::
This is the developer documentation. If you are not a developer and you are looking for information about the project, check the `official website <http://weboob.org>`_.
.. toctree::
:maxdepth: 2
overview
guides/index
api/index
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

52
docs/source/overview.rst
View file

@ -1,52 +0,0 @@
Overview
========
Weboob (`Web Outside Of Browsers`) provides:
* :doc:`applications <api/tools/application/index>` to interact with websites
* :doc:`modules </guides/module>`, each one handles a specific website
* a :doc:`core library <api/core/index>` providing all the features needed by backends
* :doc:`tools <api/tools/index>` to help develop backends and applications
Weboob is written in Python and is distributed under the AGPLv3+ license.
Architecture
------------
.. warning::
This diagram has to be redrawn.
.. image:: _static/architecture.png
Capabilities
------------
The core library defines capabilities. They represent features common to various websites.
For example, http://www.youtube.com and http://www.dailymotion.com are both videos
providers: Weboob defines the ``CapVideo`` capability.
Each module interfaces a website and implements one or many of these
capabilities. Modules can be configured, which means that the end-user can
provide personal information to access the underlaying website (login/password
for example). We call a configured module a Backend.
Multi-backend call
------------------
The core library provides a mechanism allowing applications to call many backends in
parallel, in a multi-threaded way.
For example, one could search a video on many providers websites.
Applications
------------
Applications are toolkit-agnostic. They can use Gtk, Qt or just be text-only, more adapted to reuse data through pipes.
Reporting a bug
---------------
When you report a bug on the tracker, it's important to correctly set the category as specific as possible.
Also, don't forget to give information about your version of Weboob, OS, implicated libraries.
It is often relevant to use the -d parameter on application to get verbose logs.