Formats¶
RestructuredText¶
This is the default format used from commands.
It will output analyze and possibles failures in differents RST grid tables that you can include in your RST documents.
Example¶
Analyzed
********
+-----+------------------------+------------+------------------------------+----------------------+
| # | Name | Lateness | Required | Latest release |
+=====+========================+============+==============================+======================+
| 1 | django | 187 | 1.11.9 - 6 years ago | 5.1.2 - 2 months ago |
+-----+------------------------+------------+------------------------------+----------------------+
| 2 | Pillow | 6 | 9.5.0 - 1 year, 3 months ago | 10.4.0 - 24 days ago |
+-----+------------------------+------------+------------------------------+----------------------+
| 3 | djangorestframework | - | Latest | 3.15.2 - A month ago |
+-----+------------------------+------------+------------------------------+----------------------+
| 4 | django-admin-shortcuts | 6 | 1.2.6 - 9 years ago | 3.0.1 - 4 days ago |
+-----+------------------------+------------+------------------------------+----------------------+
| 5 | requests | 55 | 2.8.1 - 8 years ago | 2.32.3 - A month ago |
+-----+------------------------+------------+------------------------------+----------------------+
| 6 | urllib3 | - | Latest | 2.2.3 - A month ago |
+-----+------------------------+------------+------------------------------+----------------------+
Failures
********
+-----+------------------------------------------+-----------------------+-------------------------------------+
| # | Source | Status | Resume |
+=====+==========================================+=======================+=====================================+
| 1 | ./downloads/numpy-1.9.2-cp34-none- | unsupported-localpath | Local package is not supported |
| | win32.whl | | |
+-----+------------------------------------------+-----------------------+-------------------------------------+
| 2 | http://wxpython.org/Phoenix/snapshot-bui | unsupported-url | Direct package URL is not supported |
| | lds/wxPython_Phoenix- | | |
+-----+------------------------------------------+-----------------------+-------------------------------------+
Rich¶
It will output analyze and possibles failures with Rich library.
This is an optional format if you installed Dependency-comb with the rich feature,
see Install document. If rich is not listed in available formats in
commands then you didn’t installed Rich.
Note
The example will look better in a terminal than on this HTML page where characters don’t display well and example has been saved without terminal colors.
Example¶
╭──────────────────────────────────────────── Analyzed ────────────────────────────────────────────╮
│ ╷ ╷ ╷ ╷ │
│ # │ Name │ Lateness │ Required │ Latest release │
│ ╺━━━┿━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━╸ │
│ 1 │ django │ 187 │ 1.11.9 - 6 years ago │ 5.1.2 - 2 months ago │
│ 2 │ Pillow │ 6 │ 9.5.0 - 1 year, 3 months ago │ 10.4.0 - 24 days ago │
│ 3 │ djangorestframework │ - │ Latest │ 3.15.2 - A month ago │
│ 4 │ django-admin-shortcuts │ 6 │ 1.2.6 - 9 years ago │ 3.0.1 - 4 days ago │
│ 5 │ requests │ 55 │ 2.8.1 - 8 years ago │ 2.32.3 - A month ago │
│ 6 │ urllib3 │ - │ Latest │ 2.2.3 - A month ago │
│ ╵ ╵ ╵ ╵ │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭──────────────────────────────────────────── Failures ────────────────────────────────────────────╮
│ ╷ ╷ ╷ │
│ # │ Source │ Status │ Resume │
│ ╺━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╸ │
│ 1 │ ./downloads/numpy-1.9.2-cp34-n… │ unsupported-localpath │ Local package is not supported │
│ │ win32.whl │ │ │
│ 2 │ http://wxpython.org/Phoenix/sn… │ unsupported-url │ Direct package URL is not │
│ │ lds/wxPython_Phoenix- │ │ supported │
│ ╵ ╵ ╵ │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
CSV¶
It will output analyze and possibles failures in a CSV structure.
When including failures table, this format is not ready to use since analyze and failures does not have the same columns.
Output will so includes two differents CSV tables that you will need to distinct yourself.
Example¶
"key","name","lateness","resolved_version","latest_release","latest_activity","release_label","release_age"
"1","django","187","1.11.9 - 6 years ago","5.1.2 - 2 months ago","2 months","1.11.9","6 years"
"2","Pillow","6","9.5.0 - 1 year, 3 months ago","10.4.0 - 24 days ago","24 days","9.5.0","1 year, 3 months"
"3","djangorestframework","-","Latest","3.15.2 - A month ago","a month","Latest",""
"4","django-admin-shortcuts","6","1.2.6 - 9 years ago","3.0.1 - 4 days ago","4 days","1.2.6","9 years"
"5","requests","55","2.8.1 - 8 years ago","2.32.3 - A month ago","a month","2.8.1","8 years"
"6","urllib3","-","Latest","2.2.3 - A month ago","a month","Latest",""
"key","source","status","resume"
"1","./downloads/numpy-1.9.2-cp34-none-
win32.whl","unsupported-localpath","Local package is not supported"
"2","http://wxpython.org/Phoenix/snapshot-bui
lds/wxPython_Phoenix-","unsupported-url","Direct package URL is not supported"
JSON¶
It will output analyze and possibles failures in a JSON structure.
Example¶
{
"analyzed": [
{
"key": 1,
"name": "django",
"lateness": 187,
"resolved_version": "1.11.9 - 6 years ago",
"latest_release": "5.1.2 - 2 months ago",
"latest_activity": "2 months",
"release_label": "1.11.9",
"release_age": "6 years"
},
{
"key": 2,
"name": "Pillow",
"lateness": 6,
"resolved_version": "9.5.0 - 1 year, 3 months ago",
"latest_release": "10.4.0 - 24 days ago",
"latest_activity": "24 days",
"release_label": "9.5.0",
"release_age": "1 year, 3 months"
},
{
"key": 3,
"name": "djangorestframework",
"lateness": "-",
"resolved_version": "Latest",
"latest_release": "3.15.2 - A month ago",
"latest_activity": "a month",
"release_label": "Latest",
"release_age": null
},
{
"key": 4,
"name": "django-admin-shortcuts",
"lateness": 6,
"resolved_version": "1.2.6 - 9 years ago",
"latest_release": "3.0.1 - 4 days ago",
"latest_activity": "4 days",
"release_label": "1.2.6",
"release_age": "9 years"
},
{
"key": 5,
"name": "requests",
"lateness": 55,
"resolved_version": "2.8.1 - 8 years ago",
"latest_release": "2.32.3 - A month ago",
"latest_activity": "a month",
"release_label": "2.8.1",
"release_age": "8 years"
},
{
"key": 6,
"name": "urllib3",
"lateness": "-",
"resolved_version": "Latest",
"latest_release": "2.2.3 - A month ago",
"latest_activity": "a month",
"release_label": "Latest",
"release_age": null
}
],
"failures": [
{
"key": 1,
"source": "./downloads/numpy-1.9.2-cp34-none-\nwin32.whl",
"status": "unsupported-localpath",
"resume": "Local package is not supported"
},
{
"key": 2,
"source": "http://wxpython.org/Phoenix/snapshot-bui\nlds/wxPython_Phoenix-",
"status": "unsupported-url",
"resume": "Direct package URL is not supported"
}
]
}