Difference between revisions of "Brunnhilde"

	Siegfried-based characterization of directories and disk images
Homepage:	https://github.com/tw4l/brunnhilde
License:	MIT License
Platforms:	Linux, macOS, OS X
Function:	Content Profiling,Metadata Extraction,Appraisal

Latest revision as of 11:44, 4 February 2022

Description[edit]

Brunnhilde is a command-line utility that runs Siegfried against a specified directory or disk image, loads the results into a sqlite3 database, and queries the database to generate reports to aid in triage, arrangement, and description of digital archives. The program will also check for viruses unless specified otherwise, and will optionally run bulk_extractor against the given source. Reports include CSVs, a tree report, and a human-readable HTML summary of the directory or disk image. All outputs are placed into a new directory named after the identifier passed to Brunnhilde as the last argument. Brunnhilde is also capable of exporting files from logical disk images utilizing many file systems, including HFS+.

Dependencies include Python (tested in 2.7 and 3.4+), Siegfried, ClamAV, bulk_extractor, Sleuth Kit, and HFSExplorer. All dependencies already installed and compiled in the BitCurator environment.

To install the command-line utility with pip: "pip install brunnhilde".

For a GUI wrapper for Brunnhilde, see the Brunnhilde GUI Github repo.

User Experiences[edit]

Development Activity[edit]

All development activity is visible on GitHub: http://github.com/tw4l/brunnhilde/commits

Release Feed[edit]

Below the last 3 release feeds:

2023-03-31 22:52:12: [tag:github.com,2008:Repository/49334861/v1.9.6 Brunnhilde 1.9.6]; by tw4l
2022-08-17 01:55:43: [tag:github.com,2008:Repository/49334861/v1.9.5 Brunnhilde 1.9.5]; by tw4l
2022-02-07 02:46:55: [tag:github.com,2008:Repository/49334861/v1.9.4 Brunnhilde 1.9.4]; by tw4l

Activity Feed[edit]

Below the last 5 commits:

2020-01-24 18:09:57: [tag:github.com,2008:Grit::Commit/f855a080a036306082a2a65c9b64ed71842112f2 Update author email]; by tim@bitarchivist.net
2020-01-24 18:08:28: [tag:github.com,2008:Grit::Commit/7fcf6eb41f1e3f66eb6d6ada00404b21a8a2816d Update GH username]; by tim@bitarchivist.net
2020-01-24 17:51:37: [tag:github.com,2008:Grit::Commit/8ae24e20f5bc754d7b726762666da56ca19c1d7d Update GH username]; by tim@bitarchivist.net
2020-01-24 17:49:14: [tag:github.com,2008:Grit::Commit/9fbe6a3391e5b88c125d5e7f9137f06129647f1c Update GH username]; by tim@bitarchivist.net
2019-02-09 18:37:02: [tag:github.com,2008:Grit::Commit/9bf39d52afb15e02920ad0961da90360038865c7 Formatting]; by timothyryanwalsh@gmail.com

@@ Line 1: / Line 1: @@
-<!-- Use the structure provided in this template, do not change it! -->
+{{Infobox tool
-{{Infobox_tool
-|purpose=A reporting companion to Siegfried
 |image=Brunnhilde.png
-|homepage=https://github.com/timothyryanwalsh/brunnhilde
+|purpose=Siegfried-based characterization of directories and disk images
+|homepage=https://github.com/tw4l/brunnhilde
 |license=MIT License
 |platforms=Linux, macOS, OS X
+|function=Content Profiling, Metadata Extraction, Appraisal
 }}
-<!-- Note that to use the image field, you should leave the value as {{PAGENAMEE}}.png (or similar) and upload a copy of the image. Hot-linking is not supported. If you don't want an image, just remove that line. -->
+{{Infobox tool details}}
+== Description ==
-<!-- Add one or more categories to describe the function of the tool, such as:
+<!-- Describe the what the tool does, focusing on it's digital preservation value. Keep it factual. -->
-[[Category:Preservation System]] or [[Category:Backup]]
+Brunnhilde is a command-line utility that runs Siegfried against a specified directory or disk image, loads the results into a sqlite3 database, and queries the database to generate reports to aid in triage, arrangement, and description of digital archives. The program will also check for viruses unless specified otherwise, and will optionally run bulk_extractor against the given source. Reports include CSVs, a tree report, and a human-readable HTML summary of the directory or disk image. All outputs are placed into a new directory named after the identifier passed to Brunnhilde as the last argument. Brunnhilde is also capable of exporting files from logical disk images utilizing many file systems, including HFS+.
-Choose carefully, and view the list of existing categories first (see the Navigation sidebar on the left) -->
-[[Category:Characterisation]]
-<!-- Add relevant categories to describe the content type that the tool addresses, such as:
+Dependencies include Python (tested in 2.7 and 3.4+), Siegfried, ClamAV, bulk_extractor, Sleuth Kit, and HFSExplorer. All dependencies already installed and compiled in the BitCurator environment.
-[[Category:Audio]] or [[Category:Document]] or [[Category:Research Data]]
-Choose carefully, and view the list of existing categories first (see the Navigation sidebar on the left). If the tool works on any content type, do not add a category. -->
+To install the command-line utility with pip: "pip install brunnhilde".
-== Description ==
+For a GUI wrapper for Brunnhilde, see the [https://github.com/tw4l/brunnhilde-GUI Brunnhilde GUI Github repo].
-<!-- Describe the what the tool does, focusing on it's digital preservation value. Keep it factual. -->
-Brunnhilde runs Siegfried against a specified directory or disk image, loads the results into a sqlite3 database, and queries the database to generate reports to aid in triage, arrangement, and description of digital archives. The program will also check for viruses unless specified otherwise, and will optionally run bulk_extractor against the given source. Reports include CSVs, a tree, and a human-readable HTML summary of the directory or disk image.
 == User Experiences ==
@@ Line 30: / Line 23: @@
 == Development Activity ==
 <!-- Provide *evidence* of development activity of the tool. For example, RSS feeds for code issues or commits. -->
-<!-- Add the OpenHub.com ID for the tool, if known. -->
+All development activity is visible on GitHub: http://github.com/tw4l/brunnhilde/commits
-{{Infobox_tool_details
-|releases_rss=https://github.com/timothyryanwalsh/brunnhilde/releases.atom
-|issues_rss=
+=== Release Feed ===
-|mailing_lists=
+Below the last 3 release feeds:
-|ohloh_id=
+<rss max=3>https://github.com/tw4l/brunnhilde/releases.atom</rss>
-}}
+=== Activity Feed ===
+Below the last 5 commits:
+<rss max=5>https://github.com/tw4l/brunnhilde/commits/master.atom</rss>