File: call_graphs.rst

package info (click to toggle)
eodag 3.10.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 48,500 kB
  • sloc: python: 41,542; xml: 3,791; makefile: 27; sh: 9
file content (28 lines) | stat: -rw-r--r-- 1,306 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.. _call_graphs:

Call graphs
===========

This section provides visual representations of the call graphs for the EODAG library.
Call graphs are useful for understanding the relationships and interactions between
different components of the codebase. They can help developers and contributors
navigate the code more effectively and identify dependencies or areas for improvement.

* `Main API calls graph <../_static/eodag_main_calls_graph.svg>`_
* `Advanced calls graph (main API + search and authentication plugins) <../_static/eodag_advanced_calls_graph.svg>`_

These call graphs are generated using *graphviz* and `Pyan3 <https://github.com/davidfraser/pyan>`_

.. code-block:: bash

   cd eodag_working_copy/eodag
   # main api
   pyan3 `find ./api -name "*.py"` \
   --uses --colored --grouped-alt --nested-groups --annotated --dot --dot-rankdir=LR \
   >/tmp/eodag_main_calls_graph.dot
   dot -Tsvg /tmp/eodag_main_calls_graph.dot >../docs/_static/eodag_main_calls_graph.svg
   # advanced api
   pyan3 `find ./api ./plugins/search/ ./plugins/authentication/ -name "*.py"` \
   --uses --colored --grouped-alt --nested-groups --annotated --dot --dot-rankdir=LR \
   >/tmp/eodag_advanced_calls_graph.dot
   dot -Tsvg /tmp/eodag_advanced_calls_graph.dot >../docs/_static/eodag_advanced_calls_graph.svg