Browse Source

docs: change weboob to woob

Romain Bignon 2 months ago
parent
commit
88fd4a6e8e

+ 2
- 2
docs/Makefile View File

@@ -61,9 +61,9 @@ qthelp:
61 61
 	@echo
62 62
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
63 63
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
64
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Weboob.qhcp"
64
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/woob.qhcp"
65 65
 	@echo "To view the help file:"
66
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Weboob.qhc"
66
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/woob.qhc"
67 67
 
68 68
 latex:
69 69
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

+ 2
- 2
docs/make.bat View File

@@ -74,9 +74,9 @@ if "%1" == "qthelp" (
74 74
 	echo.
75 75
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
76 76
 .qhcp project file in %BUILDDIR%/qthelp, like this:
77
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Weboob.qhcp
77
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\woob.qhcp
78 78
 	echo.To view the help file:
79
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Weboob.ghc
79
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\woob.ghc
80 80
 	goto end
81 81
 )
82 82
 

+ 6
- 6
docs/source/_templates/indexcontent.html View File

@@ -5,7 +5,7 @@
5 5
 {% block body %}
6 6
   <h1>{{ docstitle|e }}</h1>
7 7
   <p>
8
-  {% trans %}Welcome! This is the documentation for Weboob {{ release }}{% endtrans %}
8
+  {% trans %}Welcome! This is the documentation for woob {{ release }}{% endtrans %}
9 9
   </p>
10 10
   <div class="admonition note">
11 11
   <p class="first admonition-title">Note</p>
@@ -15,9 +15,9 @@
15 15
   <p><strong>Hello world:</strong></p>
16 16
   <table class="contentstable" align="center"><tr>
17 17
     <td width="50%">
18
-<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>
19
-<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>
20
-<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>
18
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">woob.core</span> <span class="kn">import</span> <span class="n">Woob</span>
19
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">woob.capabilities.bank</span> <span class="kn">import</span> <span class="n">CapBank</span>
20
+<span class="gp">&gt;&gt;&gt; </span><span class="n">w</span> <span class="o">=</span> <span class="n">Woob</span><span class="p">()</span>
21 21
 <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>
22 22
 <span class="go">{'societegenerale': &lt;Backend 'societegenerale'&gt;, 'creditmutuel': &lt;Backend 'creditmutuel'&gt;}</span>
23 23
 <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>
@@ -56,9 +56,9 @@
56 56
   <table class="contentstable" align="center"><tr>
57 57
     <td width="50%">
58 58
       <p class="biglink"><a class="biglink" href="{{ pathto("guides/setup") }}">Setup your development environment</a><br/>
59
-         <span class="linkdescr">configure your environment to develop on Weboob</span></p>
59
+         <span class="linkdescr">configure your environment to develop on woob</span></p>
60 60
       <p class="biglink"><a class="biglink" href="{{ pathto("guides/module") }}">Write a new module</a><br/>
61
-         <span class="linkdescr">add a website support in Weboob</span></p>
61
+         <span class="linkdescr">add a website support in woob</span></p>
62 62
       <p class="biglink"><a class="biglink" href="{{ pathto("guides/cookbook") }}">Cookbook</a><br/>
63 63
          <span class="linkdescr">recipes for common actions</span></p>
64 64
     </td><td width="50%">

+ 3
- 3
docs/source/_templates/indexsidebar.html View File

@@ -1,6 +1,6 @@
1 1
 <h3>Other resources</h3>
2 2
 <ul>
3
-  <li><a href="http://woob.tech/">Official website</a></li>
4
-  <li><a href="https://git.woob.tech/weboob/weboob/issues">Bug Tracker</a></li>
5
-  <li><a href="https://symlink.me/projects/weboob/files">Download stable version</a></li>
3
+  <li><a href="https://woob.tech/">Official website</a></li>
4
+  <li><a href="https://git.woob.tech/woob/woob/issues">Bug Tracker</a></li>
5
+  <li><a href="https://git.woob.tech/woob/woob/-/tags">Download stable version</a></li>
6 6
 </ul>

+ 8
- 8
docs/source/conf.py View File

@@ -1,6 +1,6 @@
1 1
 # -*- coding: utf-8 -*-
2 2
 #
3
-# Weboob documentation build configuration file, created by
3
+# woob documentation build configuration file, created by
4 4
 # sphinx-quickstart on Thu Nov 25 11:56:52 2010.
5 5
 #
6 6
 # This file is execfile()d with the current directory set to its containing dir.
@@ -37,11 +37,11 @@ source_suffix = '.rst'
37 37
 #source_encoding = 'utf-8'
38 38
 
39 39
 # The master toctree document.
40
-#master_doc = 'index'
40
+master_doc = 'index'
41 41
 
42 42
 # General information about the project.
43
-project = u'Weboob'
44
-copyright = '2010-%s, The Weboob Team' % time.strftime('%Y')
43
+project = u'woob'
44
+copyright = '2010-%s, The Woob Team' % time.strftime('%Y')
45 45
 
46 46
 # The version info for the project you're documenting, acts as replacement for
47 47
 # |version| and |release|, also used in various other places throughout the
@@ -108,7 +108,7 @@ html_theme = 'default'
108 108
 
109 109
 # The name for this set of Sphinx documents.  If None, it defaults to
110 110
 # "<project> v<release> documentation".
111
-#html_title = 'Weboob development'
111
+#html_title = 'Woob development'
112 112
 
113 113
 # A shorter title for the navigation bar.  Default is the same as html_title.
114 114
 #html_short_title = None
@@ -167,7 +167,7 @@ html_show_sourcelink = False
167 167
 #html_file_suffix = ''
168 168
 
169 169
 # Output file base name for HTML help builder.
170
-htmlhelp_basename = 'weboob' + release.replace('.', '')
170
+htmlhelp_basename = 'woob' + release.replace('.', '')
171 171
 
172 172
 
173 173
 # -- Options for LaTeX output --------------------------------------------------
@@ -181,8 +181,8 @@ htmlhelp_basename = 'weboob' + release.replace('.', '')
181 181
 # Grouping the document tree into LaTeX files. List of tuples
182 182
 # (source start file, target name, title, author, documentclass [howto/manual]).
183 183
 latex_documents = [
184
-    ('index', 'Weboob.tex', u'Weboob Documentation',
185
-     u'Weboob Team', 'manual'),
184
+    ('index', 'woob.tex', u'Woob Documentation',
185
+     u'Woob Team', 'manual'),
186 186
 ]
187 187
 
188 188
 # The name of an image file (relative to this directory) to place at the top of

+ 1
- 1
docs/source/contents.rst View File

@@ -1,5 +1,5 @@
1 1
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2
- Weboob Documentation contents
2
+ Woob Documentation contents
3 3
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4 4
 
5 5
 .. toctree::

+ 4
- 4
docs/source/genapi.py View File

@@ -9,14 +9,14 @@ def genapi():
9 9
     os.chdir('api')
10 10
     for root, dirs, files in os.walk('../../../weboob/'):
11 11
         root = root.split('/', 4)[-1]
12
-        if root.startswith('applications'):
12
+        if root.startswith('applications') or root.startswith('__'):
13 13
             continue
14 14
 
15 15
         if root.strip():
16 16
             os.system('mkdir -p %s' % root)
17
-            module = '.'.join(['weboob'] + root.split('/'))
17
+            module = '.'.join(['woob'] + root.split('/'))
18 18
         else:
19
-            module = 'weboob'
19
+            module = 'woob'
20 20
 
21 21
         subs = set()
22 22
         for f in files:
@@ -45,7 +45,7 @@ def genapi():
45 45
             subs.add('%s/index' % d)
46 46
 
47 47
         with open(os.path.join(root, 'index.rst'), 'w') as fp:
48
-            if module == 'weboob':
48
+            if module == 'woob':
49 49
                 m = 'API'
50 50
             else:
51 51
                 m = ':mod:`%s`' % module

+ 1
- 1
docs/source/guides/capability.rst View File

@@ -30,7 +30,7 @@ isn't available yet.
30 30
 A field which isn't loaded can be set to :class:`woob.capabilities.base.NotLoaded`.
31 31
 
32 32
 By default, in the object constructor, every fields should be set to
33
-:class:`NotLoaded <weboob.capabilities.base.NotLoaded>`, and when the backend loads them, it replaces them with
33
+:class:`NotLoaded <woob.capabilities.base.NotLoaded>`, and when the backend loads them, it replaces them with
34 34
 the new values.
35 35
 
36 36
 

+ 7
- 7
docs/source/guides/contribute.rst View File

@@ -9,7 +9,7 @@ Write a patch
9 9
 
10 10
 Help yourself with the `documentation <http://docs.woob.tech/>`_.
11 11
 
12
-Find an opened issue on `this website <https://git.woob.tech/weboob/weboob/issues>`_, or write your own bugfix or feature.
12
+Find an opened issue on `this website <https://git.woob.tech/woob/woob/issues>`_, or write your own bugfix or feature.
13 13
 Then, once it is necessary, commit with::
14 14
 
15 15
     $ git commit -a
@@ -31,12 +31,12 @@ To aid in verifying Python 3 compatibility, also run::
31 31
     $ tools/run_tests.sh -3 yourmodulename
32 32
 
33 33
 Perhaps you should also write or fix tests. These tests are automatically run by
34
-`Gitlab CI <https://git.woob.tech/weboob/weboob/pipelines>`_ at each commit and merge requests.
34
+`Gitlab CI <https://git.woob.tech/woob/woob/pipelines>`_ at each commit and merge requests.
35 35
 
36 36
 Create a merge request or send a patch
37 37
 --------------------------------------
38 38
 
39
-The easiest way to send your patch is to create a fork on `the Weboob Gitlab <https://git.woob.tech>`_ and create a merge
39
+The easiest way to send your patch is to create a fork on `the woob gitlab <https://git.woob.tech>`_ and create a merge
40 40
 request from there. This way, the code review process is easier and continuous integration is run automatically (see
41 41
 previous section).
42 42
 
@@ -45,11 +45,11 @@ previous section).
45 45
     Using the ``git+ssh`` protocol to clone the repository will only work when connected from an
46 46
     IPv6 compatible network:
47 47
 
48
-    `$ git clone gitlab@git.woob.tech:weboob/weboob.git`
48
+    `$ git clone gitlab@git.woob.tech:woob/woob.git`
49 49
 
50 50
     But it is possible to use the ``git+https`` protocol from everywhere (IPv4 and IPv6 networks):
51 51
 
52
-    `$ git clone https://git.woob.tech/weboob/weboob.git`
52
+    `$ git clone https://git.woob.tech/woob/woob.git`
53 53
 
54 54
 If you prefer good old email patches, just use
55 55
 
@@ -59,14 +59,14 @@ If you prefer good old email patches, just use
59 59
 
60 60
 Then, send them with this command::
61 61
 
62
-    $ git send-email --to=weboob@woob.tech *.patch
62
+    $ git send-email --to=woob@woob.tech *.patch
63 63
 
64 64
 You can also send the files by yourself if you haven't any configured MTA on your system.
65 65
 
66 66
 By hosting a Gitlab CI runner
67 67
 *****************************
68 68
 
69
-To be sure weboob works fine on lot of architectures, OS and configurations, but also that websites haven't changed and
69
+To be sure woob works fine on lot of architectures, OS and configurations, but also that websites haven't changed and
70 70
 backends still support them, it's important to have enough runners with different configurations, especially since
71 71
 running some tests requires a working backend.
72 72
 

+ 45
- 45
docs/source/guides/module.rst View File

@@ -1,17 +1,17 @@
1 1
 Write a new module
2 2
 ==================
3 3
 
4
-This guide aims to learn how to write a new module for `Weboob <http://woob.tech>`_.
4
+This guide aims to learn how to write a new module for `woob <http://woob.tech>`_.
5 5
 
6 6
 Before read it, you should :doc:`setup your development environment </guides/setup>`.
7 7
 
8 8
 What is a module
9 9
 ****************
10 10
 
11
-A module is an interface between a website and Weboob. It represents the python code which is stored
11
+A module is an interface between a website and woob. It represents the python code which is stored
12 12
 in repositories.
13 13
 
14
-Weboob applications need *backends* to interact with websites. A *backend* is an instance of a *module*, usually
14
+woob applications need *backends* to interact with websites. A *backend* is an instance of a *module*, usually
15 15
 with several parameters like your username, password, or other options. You can create multiple *backends*
16 16
 for a single *module*.
17 17
 
@@ -79,13 +79,13 @@ In a module directory, there are commonly these files:
79 79
 Update modules list
80 80
 -------------------
81 81
 
82
-As you are in development mode, to see your new module in ``weboob-config``'s list, you have to update ``modules/modules.list`` with this command::
82
+As you are in development mode, to see your new module in ``woob config``'s list, you have to update ``modules/modules.list`` with this command::
83 83
 
84
-    $ weboob update
84
+    $ woob config update
85 85
 
86 86
 To be sure your module is correctly added, use this command::
87 87
 
88
-    $ weboob-config info example
88
+    $ woob config info example
89 89
     .------------------------------------------------------------------------------.
90 90
     | Module example                                                               |
91 91
     +-----------------.------------------------------------------------------------'
@@ -95,7 +95,7 @@ To be sure your module is correctly added, use this command::
95 95
     | Description     | Example bank website
96 96
     | Capabilities    | CapBank, CapCollection
97 97
     | Installed       | yes
98
-    | Location        | /home/me/src/weboob/modules/example
98
+    | Location        | /home/me/src/woob/modules/example
99 99
     '-----------------'
100 100
 
101 101
 If the last command does not work, check your :doc:`repositories setup
@@ -103,7 +103,7 @@ If the last command does not work, check your :doc:`repositories setup
103 103
 module, you should take great care of setting your development environment
104 104
 correctly, or your changes to the module will not have any effect. You can also
105 105
 use ``./tools/local_run.sh`` script as a quick and dirty method of forcing
106
-Weboob applications to use local modules rather than remote ones.
106
+woob applications to use local modules rather than remote ones.
107 107
 
108 108
 
109 109
 Module class
@@ -111,8 +111,8 @@ Module class
111 111
 
112 112
 Edit ``module.py``. It contains the main class of the module derived from :class:`~woob.tools.backend.Module` class::
113 113
 
114
-    from weboob.tools.backend import Module
115
-    from weboob.capabilities.bank import CapBank
114
+    from woob.tools.backend import Module
115
+    from woob.capabilities.bank import CapBank
116 116
 
117 117
     class ExampleModule(Module, CapBank):
118 118
         NAME = 'example'                         # The name of module
@@ -120,7 +120,7 @@ Edit ``module.py``. It contains the main class of the module derived from :class
120 120
         MAINTAINER = u'John Smith'               # Name of maintainer of this module
121 121
         EMAIL = 'john.smith@example.com'         # Email address of the maintainer
122 122
         LICENSE = 'LGPLv3+'                      # License of your module
123
-        # Version of weboob
123
+        # Version of woob
124 124
         VERSION = '2.1'
125 125
 
126 126
 In the code above, you can see that your ``ExampleModule`` inherits :class:`~woob.capabilities.bank.base.CapBank`, as
@@ -152,13 +152,13 @@ Available parameters of :class:`~woob.tools.value.Value` are:
152 152
 .. note::
153 153
 
154 154
     Other classes are available to store specific types of configuration options. See :mod:`woob.tools.value
155
-    <weboob.tools.value>` for a full list of them.
155
+    <woob.tools.value>` for a full list of them.
156 156
 
157 157
 For example::
158 158
 
159
-    from weboob.tools.backend import Module, BackendConfig
160
-    from weboob.capabilities.bank import CapBank
161
-    from weboob.tools.value import Value, ValueBool, ValueInt, ValueBackendPassword
159
+    from woob.tools.backend import Module, BackendConfig
160
+    from woob.capabilities.bank import CapBank
161
+    from woob.tools.value import Value, ValueBool, ValueInt, ValueBackendPassword
162 162
 
163 163
     # ...
164 164
     class ExampleModule(Module, CapBank):
@@ -177,8 +177,8 @@ Implement capabilities
177 177
 
178 178
 You need to implement each method of all of the capabilities your module implements. For example, in our case::
179 179
 
180
-    from weboob.tools.backend import Module
181
-    from weboob.capabilities.bank import CapBank
180
+    from woob.tools.backend import Module
181
+    from woob.capabilities.bank import CapBank
182 182
 
183 183
     # ...
184 184
     class ExampleModule(Module, CapBank):
@@ -198,7 +198,7 @@ You need to implement each method of all of the capabilities your module impleme
198 198
 
199 199
 If you ran the ``boilerplate`` script command ``cap``, every methods are already in ``module.py`` and documented.
200 200
 
201
-Read :class:`documentation of the capability <weboob.capabilities.bank.base.CapBank>` to know what are types of arguments,
201
+Read :class:`documentation of the capability <woob.capabilities.bank.base.CapBank>` to know what are types of arguments,
202 202
 what are expected returned objects, and what exceptions it may raise.
203 203
 
204 204
 When you are done writing your module, you should remove all the not implemented methods from your module, as the base
@@ -216,7 +216,7 @@ Edit ``browser.py``::
216 216
 
217 217
     # -*- coding: utf-8 -*-
218 218
 
219
-    from weboob.browser import PagesBrowser
219
+    from woob.browser import PagesBrowser
220 220
 
221 221
     __all__ = ['ExampleBrowser']
222 222
 
@@ -244,7 +244,7 @@ In the file ``pages.py``, you can write, for example::
244 244
 
245 245
     # -*- coding: utf-8 -*-
246 246
 
247
-    from weboob.browser.pages import HTMLPage
247
+    from woob.browser.pages import HTMLPage
248 248
 
249 249
     __all__ = ['IndexPage', 'ListPage']
250 250
 
@@ -260,7 +260,7 @@ which list accounts.
260 260
 
261 261
 Then, you have to declare them in your browser, with the :class:`~woob.browser.url.URL` object::
262 262
 
263
-    from weboob.browser import PagesBrowser, URL
263
+    from woob.browser import PagesBrowser, URL
264 264
     from .pages import IndexPage, ListPage
265 265
 
266 266
     # ...
@@ -281,7 +281,7 @@ Each time you will go on the home page, ``IndexPage`` will be instanced and set
281 281
 
282 282
 For example, we can now implement some methods in ``ExampleBrowser``::
283 283
 
284
-    from weboob.browser import PagesBrowser
284
+    from woob.browser import PagesBrowser
285 285
 
286 286
     class ExampleBrowser(PagesBrowser):
287 287
         # ...
@@ -306,8 +306,8 @@ Use it in backend
306 306
 
307 307
 Now you have a functional browser, you can use it in your class ``ExampleModule`` by defining it with the ``BROWSER`` attribute::
308 308
 
309
-    from weboob.tools.backend import Module
310
-    from weboob.capabilities.bank import CapBank
309
+    from woob.tools.backend import Module
310
+    from woob.capabilities.bank import CapBank
311 311
 
312 312
     from .browser import ExampleBrowser
313 313
 
@@ -318,7 +318,7 @@ Now you have a functional browser, you can use it in your class ``ExampleModule`
318 318
 
319 319
 You can now access it with member ``browser``. The class is instanced at the first call to this attribute.
320 320
 
321
-For example, we can now implement :func:`CapBank.iter_accounts <weboob.capabilities.bank.base.CapBank.iter_accounts>`::
321
+For example, we can now implement :func:`CapBank.iter_accounts <woob.capabilities.bank.base.CapBank.iter_accounts>`::
322 322
 
323 323
     def iter_accounts(self):
324 324
         return self.browser.iter_accounts_list()
@@ -331,8 +331,8 @@ Login management
331 331
 When the website requires to be authenticated, you have to give credentials to the constructor of the browser. You can redefine
332 332
 the method :func:`~woob.tools.backend.Module.create_default_browser`::
333 333
 
334
-    from weboob.tools.backend import Module
335
-    from weboob.capabilities.bank import CapBank
334
+    from woob.tools.backend import Module
335
+    from woob.capabilities.bank import CapBank
336 336
 
337 337
     class ExampleModule(Module, CapBank):
338 338
         # ...
@@ -342,8 +342,8 @@ the method :func:`~woob.tools.backend.Module.create_default_browser`::
342 342
 On the browser side, you need to inherit from :func:`~woob.browser.browsers.LoginBrowser` and to implement the function
343 343
 :func:`~woob.browser.browsers.LoginBrowser.do_login`::
344 344
 
345
-    from weboob.browser import LoginBrowser
346
-    from weboob.exceptions import BrowserIncorrectPassword
345
+    from woob.browser import LoginBrowser
346
+    from woob.exceptions import BrowserIncorrectPassword
347 347
 
348 348
     class ExampleBrowser(LoginBrowser):
349 349
         login = URL('/login', LoginPage)
@@ -361,7 +361,7 @@ You may provide a custom :func:`~woob.browser.browsers.LoginBrowser.do_logout` f
361 361
 
362 362
 Also, your ``LoginPage`` may look like::
363 363
 
364
-    from weboob.browser.pages import HTMLPage
364
+    from woob.browser.pages import HTMLPage
365 365
 
366 366
     class LoginPage(HTMLPage):
367 367
         def login(self, username, password):
@@ -372,8 +372,8 @@ Also, your ``LoginPage`` may look like::
372 372
 
373 373
 Then, each method on your browser which needs your user to be authenticated may be decorated by :func:`~woob.browser.browsers.need_login`::
374 374
 
375
-    from weboob.browser import LoginBrowser, URL
376
-    from weboob.browser import need_login
375
+    from woob.browser import LoginBrowser, URL
376
+    from woob.browser import need_login
377 377
 
378 378
     class ExampleBrowser(LoginBrowser):
379 379
         accounts = URL('/accounts$', ListPage)
@@ -391,7 +391,7 @@ decorated method.
391 391
 You can either define it yourself, as a class boolean attribute or as a property, or inherit your class from :class:`~woob.browser.pages.LoggedPage`.
392 392
 In the latter case, remember that Python inheritance requires the :class:`~woob.browser.pages.LoggedPage` to be placed first such as in::
393 393
 
394
-    from weboob.browser.pages import LoggedPage, HTMLPage
394
+    from woob.browser.pages import LoggedPage, HTMLPage
395 395
 
396 396
     class OnlyForLoggedUserPage(LoggedPage, HTMLPage):
397 397
         # ...
@@ -417,11 +417,11 @@ construct the object.
417 417
 
418 418
 For example::
419 419
 
420
-    from weboob.browser.pages import LoggedPage, HTMLPage
421
-    from weboob.browser.filters.html import Attr
422
-    from weboob.browser.filters.standard import CleanDecimal, CleanText
423
-    from weboob.capabilities.bank import Account
424
-    from weboob.browser.elements import method, ListElement, ItemElement
420
+    from woob.browser.pages import LoggedPage, HTMLPage
421
+    from woob.browser.filters.html import Attr
422
+    from woob.browser.filters.standard import CleanDecimal, CleanText
423
+    from woob.capabilities.bank import Account
424
+    from woob.browser.elements import method, ListElement, ItemElement
425 425
 
426 426
     class ListPage(LoggedPage, HTMLPage):
427 427
         @method
@@ -496,7 +496,7 @@ Your module is now functional and you can use this command::
496 496
 
497 497
 .. note::
498 498
 
499
-	You can pass ``-a`` command-line argument to any Weboob application to log
499
+	You can pass ``-a`` command-line argument to any woob application to log
500 500
 	all the possible debug output (including requests and their parameters, raw
501 501
 	responses and loaded HTML pages) in a temporary directory, indicated at the
502 502
 	launch of the program.
@@ -510,7 +510,7 @@ breaks the behavior of the module.
510 510
 Edit ``test.py`` and write, for example::
511 511
 
512 512
     # -*- coding: utf-8 -*-
513
-    from weboob.tools.test import BackendTest
513
+    from woob.tools.test import BackendTest
514 514
 
515 515
     __all__ = ['ExampleTest']
516 516
 
@@ -555,8 +555,8 @@ method associated to the type of the object.
555 555
 To define what objects are supported to be filled, and what method to call, define the ``OBJECTS``
556 556
 class attribute in your ``ExampleModule``::
557 557
 
558
-    from weboob.tools.backend import Module
559
-    from weboob.capabilities.video import CapVideo
558
+    from woob.tools.backend import Module
559
+    from woob.capabilities.video import CapVideo
560 560
 
561 561
     class ExampleModule(Module, CapVideo):
562 562
         # ...
@@ -569,8 +569,8 @@ The prototype of the function might be::
569 569
 
570 570
 Then, the function might, for each requested fields, fetch the right data and fill the object. For example::
571 571
 
572
-    from weboob.tools.backend import Module
573
-    from weboob.capabilities.video import CapVideo
572
+    from woob.tools.backend import Module
573
+    from woob.capabilities.video import CapVideo
574 574
 
575 575
     class ExampleModule(Module, CapVideo):
576 576
         # ...
@@ -581,7 +581,7 @@ Then, the function might, for each requested fields, fetch the right data and fi
581 581
 
582 582
             return video
583 583
 
584
-Here, when the application has got a :class:`Video <weboob.capabilities.video.BaseVideo>` object with
584
+Here, when the application has got a :class:`Video <woob.capabilities.video.BaseVideo>` object with
585 585
 :func:`~woob.capabilities.video.CapVideo.search_videos`, in most cases, there are only some meta-data, but not the direct link to the video media.
586 586
 
587 587
 As our method :func:`~woob.capabilities.video.CapVideo.get_video` will get all

+ 10
- 10
docs/source/guides/setup.rst View File

@@ -1,19 +1,19 @@
1 1
 Setup your development environment
2 2
 ==================================
3 3
 
4
-To develop on Weboob, you have to setup a development environment.
4
+To develop on woob, you have to setup a development environment.
5 5
 
6 6
 Git installation
7 7
 ----------------
8 8
 
9 9
 Clone a git repository with this command::
10 10
 
11
-    $ git clone https://git.woob.tech/weboob/weboob.git
11
+    $ git clone https://git.woob.tech/woob/woob.git
12 12
 
13
-We don't want to install Weboob on the whole system, so we create local directories where
13
+We don't want to install woob on the whole system, so we create local directories where
14 14
 we will put symbolic links to sources::
15 15
 
16
-    $ cd $HOME/src/weboob
16
+    $ cd $HOME/src/woob
17 17
 
18 18
 If not in a virtualenv, executables are in ``~/.local/bin`` and modules are in
19 19
 ``~/.local/lib/``:
@@ -28,20 +28,20 @@ If inside a virtualenv, no need to update the paths, they are all in the virtual
28 28
 Repositories setup
29 29
 ------------------
30 30
 
31
-As you may know, Weboob installs modules from `remote repositories <http://woob.tech/modules>`_. As you
31
+As you may know, woob installs modules from `remote repositories <http://woob.tech/modules>`_. As you
32 32
 probably want to use modules in sources instead of stable ones, because you will change them, or create
33
-a new one, you have to add this line at end of ``~/.config/weboob/sources.list``::
33
+a new one, you have to add this line at end of ``~/.config/woob/sources.list``::
34 34
 
35
-    file:///home/me/src/weboob/modules
35
+    file:///home/me/src/woob/modules
36 36
 
37 37
 Then, run this command::
38 38
 
39
-    $ weboob-config update
39
+    $ woob config update
40 40
 
41
-Run Weboob without installation
41
+Run woob without installation
42 42
 -------------------------------
43 43
 
44
-This does not actually install anything, but lets you run Weboob from the source code,
44
+This does not actually install anything, but lets you run woob from the source code,
45 45
 while also using the modules from that source::
46 46
 
47 47
     $ ./tools/local_run.sh APPLICATION COMMANDS