search

CS-SI / eodag

Earth Observation Data Access Gateway
https://eodag.readthedocs.io
Apache License 2.0
326 stars 44 forks source link

docs: developer documentation update #1327

Closed sbrunato closed 1 month ago

sbrunato commented 1 month ago
github-actions[bot] commented 1 month ago

Test Results

    4 files  ±0      4 suites  ±0   6m 13s :stopwatch: +3s   562 tests ±0    559 :white_check_mark: ±0   3 :zzz: ±0  0 :x: ±0  2 248 runs  ±0  2 154 :white_check_mark: ±0  94 :zzz: ±0  0 :x: ±0 

Results for commit 4ab29dbb. ± Comparison against base commit 30614029.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

badge

Code Coverage (Ubuntu)

``` Filename Stmts Miss Cover Missing ----------------------------------------- ------- ------ ------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ __init__.py 8 0 100.00% cli.py 312 59 81.09% 655-714, 816-867, 871 config.py 362 27 92.54% 80-82, 91, 99, 103-105, 173, 184, 568-570, 630-633, 676-677, 686-687, 792, 855-860, 862 crunch.py 5 5 0.00% 20-24 api/__init__.py 0 0 100.00% api/core.py 769 74 90.38% 635, 679-682, 720, 764, 798, 851-856, 882, 973, 1041, 1179, 1264-1276, 1312, 1314, 1342, 1346-1357, 1370-1376, 1459-1462, 1495-1515, 1567, 1584-1588, 1600-1603, 1625-1632, 1942, 1966-1972, 2223, 2227-2230, 2241-2243, 2275 api/search_result.py 59 4 93.22% 83, 92, 99, 113 api/product/__init__.py 6 0 100.00% api/product/_assets.py 48 5 89.58% 75, 147, 155, 158-162 api/product/_product.py 187 20 89.30% 70-72, 237-238, 313, 342, 399, 413-416, 429, 453-456, 499-505 api/product/metadata_mapping.py 680 68 90.00% 130-132, 227, 259-260, 306-307, 317-329, 331, 342, 348-360, 405-406, 443, 464-467, 490, 498-499, 575-576, 600-601, 607-610, 625-626, 775, 821, 992-997, 1124, 1138-1158, 1178, 1183, 1312, 1326, 1397, 1449, 1489-1493, 1508 api/product/drivers/__init__.py 6 0 100.00% api/product/drivers/base.py 6 1 83.33% 38 plugins/__init__.py 0 0 100.00% plugins/base.py 21 2 90.48% 48, 55 plugins/manager.py 130 12 90.77% 104-109, 159, 197, 219, 223, 247, 281-282 plugins/apis/__init__.py 0 0 100.00% plugins/apis/base.py 4 0 100.00% plugins/apis/ecmwf.py 91 8 91.21% 149-151, 198-199, 225-227 plugins/apis/usgs.py 180 31 82.78% 132, 234, 268, 303-305, 310, 336-337, 342, 372-379, 390-395, 417-423, 425-431, 454 plugins/authentication/__init__.py 6 1 83.33% 31 plugins/authentication/aws_auth.py 19 0 100.00% plugins/authentication/base.py 17 2 88.24% 34, 47 plugins/authentication/generic.py 14 2 85.71% 40, 50 plugins/authentication/header.py 19 0 100.00% plugins/authentication/keycloak.py 48 4 91.67% 134, 160-165 plugins/authentication/oauth.py 13 7 46.15% 32-34, 38-41 plugins/authentication/openid_connect.py 187 17 90.91% 114, 128-154, 162, 316-319, 345 plugins/authentication/qsauth.py 34 1 97.06% 83 plugins/authentication/sas_auth.py 47 1 97.87% 76 plugins/authentication/token.py 89 16 82.02% 79, 108, 110, 133-146, 202-206 plugins/authentication/token_exchange.py 36 20 44.44% 74-80, 92-122 plugins/crunch/__init__.py 0 0 100.00% plugins/crunch/base.py 10 1 90.00% 40 plugins/crunch/filter_date.py 59 14 76.27% 49-54, 66, 75, 84, 87, 99-101, 110-112, 119 plugins/crunch/filter_latest_intersect.py 47 8 82.98% 51-52, 68, 77-80, 82, 89-92 plugins/crunch/filter_latest_tpl_name.py 31 1 96.77% 83 plugins/crunch/filter_overlap.py 66 18 72.73% 28-30, 68-71, 78-81, 87, 95, 106-122 plugins/crunch/filter_property.py 30 7 76.67% 54-59, 62-63, 79-83 plugins/download/__init__.py 0 0 100.00% plugins/download/aws.py 491 163 66.80% 266, 279, 346-349, 363-367, 409-411, 415, 447-448, 454-458, 487, 519, 523, 530, 560-568, 572, 604-612, 623-625, 656-730, 748-808, 819-824, 836-849, 874, 889-891, 894, 904-912, 920-933, 943-974, 981-993, 1031, 1057, 1102-1104, 1324 plugins/download/base.py 253 51 79.84% 136, 164, 296-297, 314-320, 351-355, 361-362, 404, 407-421, 433, 437, 501-505, 535-536, 544-561, 568-576, 578-582, 625, 647, 669, 677 plugins/download/creodias_s3.py 17 9 47.06% 44-58 plugins/download/http.py 534 129 75.84% 195-207, 209-210, 242-245, 306-309, 311-312, 319-324, 342-357, 374-376, 388, 436, 443-449, 467, 481, 495, 503-505, 521-526, 537, 555, 597-601, 623, 663, 708, 722-728, 757-821, 839, 869-878, 900-901, 928-933, 939, 942, 958, 975-976, 1006-1007, 1014, 1075-1081, 1136-1137, 1143, 1153, 1189, 1225, 1243-1256, 1282-1284 plugins/download/s3rest.py 116 24 79.31% 113, 149, 156, 191, 218-225, 228-230, 234, 245-251, 259-260, 263-267, 290, 311-314 plugins/search/__init__.py 22 0 100.00% plugins/search/base.py 132 13 90.15% 102, 106, 117, 276, 296, 352-353, 373, 376-384 plugins/search/build_search_result.py 189 24 87.30% 96, 137-138, 144, 155, 289-292, 321, 356-373, 422, 451, 454, 464, 481, 509, 511 plugins/search/cop_marine.py 236 50 78.81% 55, 63-65, 75-76, 81, 86-87, 103, 105, 108, 143-145, 157-158, 200, 206, 210, 214, 227, 238-239, 247, 275, 279, 294, 298, 302, 306, 310-314, 320-323, 326-340, 357, 406-410, 415, 427 plugins/search/creodias_s3.py 55 3 94.55% 58, 76, 110 plugins/search/csw.py 105 81 22.86% 58-59, 63-64, 72-120, 126-139, 147-179, 197-238 plugins/search/data_request_search.py 202 69 65.84% 90-93, 109, 120, 124-125, 136, 141, 146, 153, 166-169, 223-224, 228, 238-244, 249, 275-278, 286-297, 314, 316, 323-326, 328-329, 347-351, 384, 394, 405, 418, 424-439, 444 plugins/search/qssearch.py 718 96 86.63% 390, 394-400, 408-409, 515-527, 571, 587, 597, 616-631, 668-671, 742-743, 791, 810, 817, 829, 886, 907, 910-911, 920-921, 930-931, 940-941, 968, 1039-1044, 1048-1057, 1091, 1113, 1173, 1222, 1286, 1289-1290, 1372-1376, 1438, 1441, 1447-1448, 1469, 1496-1508, 1515, 1547-1549, 1559-1565, 1595, 1618, 1633, 1649, 1724-1727, 1732-1735, 1762-1763, 1778 plugins/search/static_stac_search.py 72 10 86.11% 98-125, 141, 154 rest/__init__.py 4 2 50.00% 21-22 rest/cache.py 33 7 78.79% 35-37, 53-55, 59, 68 rest/config.py 26 0 100.00% rest/constants.py 6 0 100.00% rest/core.py 251 64 74.50% 216-217, 273, 281, 298-316, 331-369, 460, 502-533, 680, 687-735 rest/errors.py 67 5 92.54% 106, 116, 127, 140-141 rest/server.py 188 24 87.23% 89, 112-114, 277-282, 310, 495-497, 514-519, 548, 550, 554-555, 559-560 rest/stac.py 319 63 80.25% 306, 328, 380-383, 410-437, 468-470, 493, 525-526, 608-648, 670-686, 778-782, 789, 843-844, 905, 995-997 rest/types/__init__.py 0 0 100.00% rest/types/collections_search.py 13 13 0.00% 18-44 rest/types/eodag_search.py 176 5 97.16% 225-229, 282, 285, 353 rest/types/queryables.py 56 1 98.21% 164 rest/types/stac_search.py 126 7 94.44% 129, 175, 190-192, 200, 204 rest/utils/__init__.py 93 12 87.10% 108-109, 128-130, 182, 192-206 rest/utils/cql_evaluate.py 48 5 89.58% 69, 76, 90, 97, 105 rest/utils/rfc3339.py 23 3 86.96% 48, 60, 62 types/__init__.py 114 14 87.72% 53, 70, 129-132, 199, 213-222, 232, 253, 266 types/bbox.py 43 19 55.81% 46-61, 72-74, 85-87, 99-101, 113-115, 123 types/download_args.py 9 0 100.00% types/queryables.py 81 0 100.00% types/search_args.py 70 18 74.29% 60-64, 71-88, 103 types/whoosh.py 15 0 100.00% utils/__init__.py 500 37 92.60% 85, 90, 194-195, 204-231, 234, 248, 328-332, 406-410, 429-431, 510, 525, 561-562, 926-929, 937-938, 976-977, 1148 utils/constraints.py 119 38 68.07% 62, 89-98, 139, 144, 148, 159, 182-184, 194, 208-224, 233-244 utils/exceptions.py 40 2 95.00% 98-99 utils/import_system.py 28 19 32.14% 64-78, 89-99 utils/logging.py 28 1 96.43% 41 utils/notebook.py 44 23 47.73% 25-29, 36-41, 58-62, 72-78, 83-87 utils/repr.py 30 8 73.33% 36, 38, 42, 76, 94-101 utils/requests.py 55 11 80.00% 64, 86, 88, 90, 92, 94, 110, 118-120, 128 utils/rest.py 36 1 97.22% 55 utils/stac_reader.py 111 45 59.46% 56-57, 63-85, 95-97, 101, 137, 153-156, 203-212, 222-252 TOTAL 9540 1605 83.18% ```

Diff against develop

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
config.py        -5       0  -0.10%
TOTAL            -5       0  +100.00%

Results for commit: 4ab29dbb4d3819e1fccee68174818a54c560759d

Minimum allowed coverage is 70%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 1 month ago

badge

Code Coverage (Windows)

``` Filename Stmts Miss Cover Missing ----------------------------------------- ------- ------ ------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- __init__.py 8 0 100.00% cli.py 312 59 81.09% 655-714, 816-867, 871 config.py 362 28 92.27% 80-82, 91, 99, 103-105, 173, 184, 568-570, 630-633, 676-677, 686-687, 792, 823, 855-860, 862 crunch.py 5 5 0.00% 20-24 api/__init__.py 0 0 100.00% api/core.py 769 74 90.38% 635, 679-682, 720, 764, 798, 851-856, 882, 973, 1041, 1179, 1264-1276, 1312, 1314, 1342, 1346-1357, 1370-1376, 1459-1462, 1495-1515, 1567, 1584-1588, 1600-1603, 1625-1632, 1942, 1966-1972, 2223, 2227-2230, 2241-2243, 2275 api/search_result.py 59 4 93.22% 83, 92, 99, 113 api/product/__init__.py 6 0 100.00% api/product/_assets.py 48 5 89.58% 75, 147, 155, 158-162 api/product/_product.py 187 20 89.30% 70-72, 237-238, 313, 342, 399, 413-416, 429, 453-456, 499-505 api/product/metadata_mapping.py 680 68 90.00% 130-132, 227, 259-260, 306-307, 317-329, 331, 342, 348-360, 405-406, 443, 464-467, 490, 498-499, 575-576, 600-601, 607-610, 625-626, 775, 821, 992-997, 1124, 1138-1158, 1178, 1183, 1312, 1326, 1397, 1449, 1489-1493, 1508 api/product/drivers/__init__.py 6 0 100.00% api/product/drivers/base.py 6 1 83.33% 38 plugins/__init__.py 0 0 100.00% plugins/base.py 21 3 85.71% 48, 55, 68 plugins/manager.py 130 12 90.77% 104-109, 159, 197, 219, 223, 247, 281-282 plugins/apis/__init__.py 0 0 100.00% plugins/apis/base.py 4 0 100.00% plugins/apis/ecmwf.py 91 8 91.21% 149-151, 198-199, 225-227 plugins/apis/usgs.py 180 31 82.78% 132, 234, 268, 303-305, 310, 336-337, 342, 372-379, 390-395, 417-423, 425-431, 454 plugins/authentication/__init__.py 6 1 83.33% 31 plugins/authentication/aws_auth.py 19 0 100.00% plugins/authentication/base.py 17 2 88.24% 34, 47 plugins/authentication/generic.py 14 2 85.71% 40, 50 plugins/authentication/header.py 19 0 100.00% plugins/authentication/keycloak.py 48 4 91.67% 134, 160-165 plugins/authentication/oauth.py 13 7 46.15% 32-34, 38-41 plugins/authentication/openid_connect.py 187 17 90.91% 114, 128-154, 162, 316-319, 345 plugins/authentication/qsauth.py 34 1 97.06% 83 plugins/authentication/sas_auth.py 47 1 97.87% 76 plugins/authentication/token.py 89 16 82.02% 79, 108, 110, 133-146, 202-206 plugins/authentication/token_exchange.py 36 20 44.44% 74-80, 92-122 plugins/crunch/__init__.py 0 0 100.00% plugins/crunch/base.py 10 1 90.00% 40 plugins/crunch/filter_date.py 59 14 76.27% 49-54, 66, 75, 84, 87, 99-101, 110-112, 119 plugins/crunch/filter_latest_intersect.py 47 33 29.79% 48-53, 66-111 plugins/crunch/filter_latest_tpl_name.py 31 1 96.77% 83 plugins/crunch/filter_overlap.py 66 18 72.73% 28-30, 68-71, 78-81, 87, 95, 106-122 plugins/crunch/filter_property.py 30 7 76.67% 54-59, 62-63, 79-83 plugins/download/__init__.py 0 0 100.00% plugins/download/aws.py 491 163 66.80% 266, 279, 346-349, 363-367, 409-411, 415, 447-448, 454-458, 487, 519, 523, 530, 560-568, 572, 604-612, 623-625, 656-730, 748-808, 819-824, 836-849, 874, 889-891, 894, 904-912, 920-933, 943-974, 981-993, 1031, 1057, 1102-1104, 1324 plugins/download/base.py 253 53 79.05% 136, 164, 231-233, 296-297, 314-320, 351-355, 361-362, 404, 407-421, 433, 437, 501-505, 535-536, 544-561, 568-576, 578-582, 625, 647, 669, 677 plugins/download/creodias_s3.py 17 9 47.06% 44-58 plugins/download/http.py 534 130 75.66% 195-207, 209-210, 242-245, 306-309, 311-312, 319-324, 342-357, 374-376, 388, 436, 443-449, 467, 481, 495, 503-505, 521-526, 537, 555, 597-601, 623, 663, 708, 722-728, 757-821, 839, 869-878, 900-901, 928-933, 939, 942, 958, 975-976, 989, 1006-1007, 1014, 1075-1081, 1136-1137, 1143, 1153, 1189, 1225, 1243-1256, 1282-1284 plugins/download/s3rest.py 116 24 79.31% 113, 149, 156, 191, 218-225, 228-230, 234, 245-251, 259-260, 263-267, 290, 311-314 plugins/search/__init__.py 22 0 100.00% plugins/search/base.py 132 14 89.39% 102, 106, 117, 276, 296, 352-353, 373, 376-384, 386 plugins/search/build_search_result.py 189 31 83.60% 96, 137-138, 144, 155, 289-292, 321, 356-373, 422, 451, 454, 464, 481, 501-516 plugins/search/cop_marine.py 236 50 78.81% 55, 63-65, 75-76, 81, 86-87, 103, 105, 108, 143-145, 157-158, 200, 206, 210, 214, 227, 238-239, 247, 275, 279, 294, 298, 302, 306, 310-314, 320-323, 326-340, 357, 406-410, 415, 427 plugins/search/creodias_s3.py 55 3 94.55% 58, 76, 110 plugins/search/csw.py 105 81 22.86% 58-59, 63-64, 72-120, 126-139, 147-179, 197-238 plugins/search/data_request_search.py 202 69 65.84% 90-93, 109, 120, 124-125, 136, 141, 146, 153, 166-169, 223-224, 228, 238-244, 249, 275-278, 286-297, 314, 316, 323-326, 328-329, 347-351, 384, 394, 405, 418, 424-439, 444 plugins/search/qssearch.py 718 125 82.59% 390, 394-400, 408-409, 515-527, 571, 574, 587, 597, 616-631, 668-671, 742-743, 791, 810, 817, 829, 886, 907, 910-911, 920-921, 930-931, 940-941, 968, 1039-1044, 1048-1057, 1091, 1113, 1173, 1222, 1286, 1289-1290, 1372-1376, 1438, 1441, 1447-1448, 1469, 1496-1508, 1515, 1547-1549, 1559-1565, 1595, 1618, 1633, 1649, 1707-1807 plugins/search/static_stac_search.py 72 10 86.11% 98-125, 141, 154 rest/__init__.py 4 2 50.00% 21-22 rest/cache.py 33 22 33.33% 35-37, 44-70 rest/config.py 26 1 96.15% 36 rest/constants.py 6 0 100.00% rest/core.py 251 139 44.62% 162, 164, 166, 169-170, 184-194, 206-207, 209-210, 216-217, 220, 223, 264-318, 331-369, 400-434, 449-465, 481-490, 502-533, 550, 592-641, 680, 687-735 rest/errors.py 67 47 29.85% 60, 65-100, 105-108, 115-118, 126-144, 152-157, 172-178 rest/server.py 188 188 0.00% 18-573 rest/stac.py 319 68 78.68% 240, 306, 328, 380-383, 410-437, 468-470, 493, 525-526, 608-648, 670-686, 713, 778-782, 789, 843-844, 850, 905, 943, 976, 995-997 rest/types/__init__.py 0 0 100.00% rest/types/collections_search.py 13 13 0.00% 18-44 rest/types/eodag_search.py 176 16 90.91% 225-229, 262-264, 282, 285, 291, 295, 353, 370-380 rest/types/queryables.py 56 13 76.79% 51-52, 59-60, 67-68, 94-99, 108-109, 164 rest/types/stac_search.py 126 11 91.27% 127-129, 175, 190-192, 200, 204, 252, 255 rest/utils/__init__.py 93 30 67.74% 79-85, 105, 108-109, 128-130, 143, 150, 175-183, 190-211 rest/utils/cql_evaluate.py 48 5 89.58% 69, 76, 90, 97, 105 rest/utils/rfc3339.py 23 5 78.26% 43-44, 48, 60, 62 types/__init__.py 114 39 65.79% 53, 66-70, 81-93, 120-122, 129-132, 172, 199, 209-225, 230, 232, 253, 258, 266, 276 types/bbox.py 43 19 55.81% 46-61, 72-74, 85-87, 99-101, 113-115, 123 types/download_args.py 9 0 100.00% types/queryables.py 81 0 100.00% types/search_args.py 70 18 74.29% 60-64, 71-88, 103 types/whoosh.py 15 0 100.00% utils/__init__.py 500 37 92.60% 85, 90, 194-195, 204-231, 234, 248, 328-332, 406-410, 429-431, 510, 525, 561-562, 926-929, 937-938, 976-977, 1148 utils/constraints.py 119 38 68.07% 62, 89-98, 139, 144, 148, 159, 182-184, 194, 208-224, 233-244 utils/exceptions.py 40 2 95.00% 98-99 utils/import_system.py 28 19 32.14% 64-78, 89-99 utils/logging.py 28 1 96.43% 41 utils/notebook.py 44 23 47.73% 25-29, 36-41, 58-62, 72-78, 83-87 utils/repr.py 30 8 73.33% 36, 38, 42, 76, 94-101 utils/requests.py 55 11 80.00% 64, 86, 88, 90, 92, 94, 110, 118-120, 128 utils/rest.py 36 1 97.22% 55 utils/stac_reader.py 111 45 59.46% 56-57, 63-85, 95-97, 101, 137, 153-156, 203-212, 222-252 TOTAL 9540 2046 78.55% ```

Diff against develop

Filename      Stmts    Miss  Cover
----------  -------  ------  -------
config.py        -5       0  -0.10%
TOTAL            -5       0  -0.01%

Results for commit: 4ab29dbb4d3819e1fccee68174818a54c560759d

Minimum allowed coverage is 70%

:recycle: This comment has been updated with latest results