change way to describe fields of CapBaseObject, and lot of documentation
This commit is contained in:
parent
99391a95ef
commit
c6a141595c
35 changed files with 1630 additions and 638 deletions
|
|
@ -1,5 +0,0 @@
|
|||
Applications
|
||||
============
|
||||
|
||||
boobank
|
||||
-------
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
Backends
|
||||
========
|
||||
|
||||
cragr
|
||||
-----
|
||||
|
|
@ -10,8 +10,7 @@ def genapi():
|
|||
os.chdir('api')
|
||||
for root, dirs, files in os.walk('../../../weboob/'):
|
||||
root = root.split('/', 4)[-1]
|
||||
if root.startswith('applications') or \
|
||||
root.startswith('backends'):
|
||||
if root.startswith('applications'):
|
||||
continue
|
||||
|
||||
if root.strip():
|
||||
|
|
@ -26,7 +25,7 @@ def genapi():
|
|||
continue
|
||||
|
||||
f, ext = f.rsplit('.', 1)
|
||||
if ext == 'pyc' or f == '__init__':
|
||||
if ext != 'py' or f == '__init__':
|
||||
continue
|
||||
|
||||
subs.add(f)
|
||||
|
|
|
|||
|
|
@ -3,18 +3,12 @@ Weboob
|
|||
|
||||
This is the developer documentation.
|
||||
|
||||
.. warning::
|
||||
This documentation is being written.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
overview
|
||||
install
|
||||
backends
|
||||
applications
|
||||
guides/index
|
||||
api/index
|
||||
|
||||
|
|
|
|||
|
|
@ -1,30 +0,0 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
If you install Weboob from sources, you'll want to install the Python egg in development mode.
|
||||
You'll be able to update the git repository with remote changes, without re-installing the software.
|
||||
And if you plan to hack on Weboob, you'll see your own changes apply the same way.
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
As root:
|
||||
|
||||
``# ./setup.py develop``
|
||||
|
||||
The development mode installation doesn't copies files, but creates an egg-link
|
||||
in the Python system packages directory:
|
||||
|
||||
* ``/usr/lib/python2.5/site-packages`` for Python 2.5
|
||||
* ``/usr/local/lib/python2.6/dist-packages`` for Python 2.6
|
||||
|
||||
Scripts are copied to:
|
||||
|
||||
* ``/usr/bin`` for Python 2.5
|
||||
* ``/usr/local/bin`` for Python 2.6
|
||||
|
||||
Uninstall
|
||||
---------
|
||||
|
||||
* remove the ``/usr/local/lib/python2.6/dist-packages/weboob.egg-link``
|
||||
* remove the weboob line from ``/usr/local/lib/python2.6/dist-packages/easy-install.pth``
|
||||
|
|
@ -3,21 +3,13 @@ Overview
|
|||
|
||||
Weboob (Web Out Of Browsers) provides:
|
||||
|
||||
* :doc:`applications` to interact with websites
|
||||
* :doc:`backends`, each one handles a specific website
|
||||
* :doc:`applications <api/tools/application/index>` to interact with websites
|
||||
* :doc:`backends <api/tools/backend>`, 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.
|
||||
|
||||
Why using Weboob?
|
||||
-----------------
|
||||
|
||||
* you get essential information from websites faster
|
||||
* you can write scripts using weboob to automate tasks
|
||||
* you can extend websites features
|
||||
* it helps blind people using crappy websites
|
||||
|
||||
Architecture
|
||||
------------
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue