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 16:35, 5 February 2026

Description

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

DPC blog post by Niamh Murphy on the installation of Brunnhilde: https://www.dpconline.org/blog/blog-niamh-murphy-brunnhilde-installation
DPC blog highlighting various use cases of Brunnhilde in workflows: https://www.dpconline.org/blog/wdpd/blog-niamh-murphy-wdpd2024

Development Activity

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

Release Feed

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

Below the last 5 commits:

2023-10-22 14:13:24: [tag:github.com,2008:Grit::Commit/94e5e2c0eea4393309e98ba45e5c1606343b60b2 Remove Python 2.7 from CI and update test versions]; by tw4l https://github.com/tw4l
2023-10-22 13:19:34: [tag:github.com,2008:Grit::Commit/e2508e7b430ee637b36b3399e8a9f9fdd00cc07b Bump CI OS to ubuntu-22.04]; by tw4l https://github.com/tw4l
2023-10-20 16:14:53: [tag:github.com,2008:Grit::Commit/6c03b9d6a765ded798a7c5fbaf8f47bcc34b9232 Update README.md - remove reference to installing requests module (#62)]; by kieranjol https://github.com/kieranjol
2023-04-01 01:44:11: [tag:github.com,2008:Grit::Commit/cbaf1667578aa1b6bd4db0df731a186c4e90754a Add Makefile with packaging and publishing helpers]; by tw4l https://github.com/tw4l
2023-03-31 22:38:27: [tag:github.com,2008:Grit::Commit/385fa4214cc37e25c2bfe7f705adb35dabe4a3df Fix GitHub Actions CI]; by tw4l https://github.com/tw4l

@@ 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}}
-<!-- Add one or more categories to describe the function of the tool, such as:
-[[Category:Preservation System]] or [[Category:Backup]]
-Choose carefully, and view the list of existing categories first (see the Navigation sidebar on the left) -->
-[[Category:Metadata Extraction]]
-[[Category:De-Duplication]]
-[[Category:Category:De-Duplication]]
-<!-- Add relevant categories to describe the content type that the tool addresses, such as:
-[[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. -->
 == Description ==
 <!-- Describe the what the tool does, focusing on it's digital preservation value. Keep it factual. -->
-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, 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+.
+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.
-Dependencies include Python (tested in 2.7 and 3.5), Siegfried, ClamAV, bulk_extractor, Sleuth Kit, and HFSExplorer. Nearly all dependencies already installed and compiled in Bitcurator.
+To install the command-line utility with pip: "pip install brunnhilde".
-For a GUI wrapper for Brunnhilde, see the [https://github.com/timothyryanwalsh/brunnhilde-GUI Brunnhilde GUI Github repo].
+For a GUI wrapper for Brunnhilde, see the [https://github.com/tw4l/brunnhilde-GUI Brunnhilde GUI Github repo].
 == User Experiences ==
 <!-- Add hotlinks to user experiences with the tool (eg. blog posts). These should illustrate the effectiveness (or otherwise) of the tool. Use a bullet list. -->
+* '''DPC blog post by Niamh Murphy on the installation of Brunnhilde:''' https://www.dpconline.org/blog/blog-niamh-murphy-brunnhilde-installation
+* '''DPC blog highlighting various use cases of Brunnhilde in workflows:''' https://www.dpconline.org/blog/wdpd/blog-niamh-murphy-wdpd2024
 == 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.atom</rss>