Difference between revisions of "Siegfried"

From COPTR
Jump to navigation Jump to search
m (updated license)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- Use the structure provided in this template, do not change it! -->
+
{{Infobox tool
 
 
{{Infobox_tool
 
 
|purpose=A PRONOM based, command line, file format identification tool using Aho Corasick matching and no buffer limits.
 
|purpose=A PRONOM based, command line, file format identification tool using Aho Corasick matching and no buffer limits.
|image=
 
 
|homepage=http://www.itforarchivists.com/siegfried
 
|homepage=http://www.itforarchivists.com/siegfried
|license=Simplified BSD License
+
|license=Apache License 2.0
|platforms=
+
|function=File Format Identification
 
}}
 
}}
<!-- 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:Metadata Extraction]] or [[Category:Preservation System]] or [[Category:Backup]]
 
Choose carefully, and view the list of existing categories first (see the Navigation sidebar on the left) -->
 
[[Category:File Format Identification]]
 
 
 
<!-- 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 ==
 
== Description ==
 
<!-- Describe the what the tool does, focusing on it's digital preservation value. Keep it factual. -->
 
<!-- Describe the what the tool does, focusing on it's digital preservation value. Keep it factual. -->
 
Siegried is a file format identification tool that, like DROID and Fido, is based on PRONOM. However, it uses a different pattern matching algorithm that offers different strengths and weaknesses to those other PRONOM based tools. A detailed description of the tool and why it was created can be found in [http://www.openplanetsfoundation.org/blogs/2014-09-27-siegfried-pronom-based-file-format-identification-tool this blog post].
 
Siegried is a file format identification tool that, like DROID and Fido, is based on PRONOM. However, it uses a different pattern matching algorithm that offers different strengths and weaknesses to those other PRONOM based tools. A detailed description of the tool and why it was created can be found in [http://www.openplanetsfoundation.org/blogs/2014-09-27-siegfried-pronom-based-file-format-identification-tool this blog post].
 +
Besides, there is a more detailed description in terms of functionality on the [https://github.com/richardlehane/siegfried Github Page of Siegfried].
 +
 +
Siegfried was first publicly released the 28th february 2014 in version 0.1.
  
 
== User Experiences ==
 
== 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. -->
 
<!-- 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. -->
 +
* '''ZBW:'''
 +
** The command line tool is very easy to handle. <br />The default output is yaml. This can be changed to csv or json.
 +
***Usual command: sf file.ext (will output in yaml)
 +
***Change output to csv: sf -csv file.ext
 +
***Change output to json: sf -json file.ext
 +
**It is also possible to save the output in an external file:
 +
***sf file.ext >output.yml
 +
***sf -csv file.ext >output.csv
 +
***sf -json file.ext >output.json
  
 
== Development Activity ==
 
== Development Activity ==
 
<!-- Provide *evidence* of development activity of the tool. For example, RSS feeds for code issues or commits. -->
 
<!-- Provide *evidence* of development activity of the tool. For example, RSS feeds for code issues or commits. -->
 +
All development activity is visible on GitHub: http://github.com/richardlehane/siegfried/commits
 +
 +
 +
=== Release Feed ===
 +
Below the last 3 release feeds:
 +
<rss max=3>https://github.com/richardlehane/siegfried/releases.atom</rss>
 +
 
 +
 +
=== Activity Feed ===
 +
Below the last 5 commits:
 +
<rss max=5>https://github.com/richardlehane/siegfried/commits/main.atom</rss>
 +
  
 
<!-- Add the Ohloh.com ID for the tool, if known. -->
 
<!-- Add the Ohloh.com ID for the tool, if known. -->
{{Infobox_tool_details
 
|ohloh_id=
 
}}
 
 
<rss max=7>https://github.com/richardlehane/siegfried/commits/master.atom</rss>
 

Latest revision as of 14:24, 25 November 2022




A PRONOM based, command line, file format identification tool using Aho Corasick matching and no buffer limits.
Homepage:http://www.itforarchivists.com/siegfried
License:Apache License 2.0
Function:File Format Identification




Description[edit]

Siegried is a file format identification tool that, like DROID and Fido, is based on PRONOM. However, it uses a different pattern matching algorithm that offers different strengths and weaknesses to those other PRONOM based tools. A detailed description of the tool and why it was created can be found in this blog post. Besides, there is a more detailed description in terms of functionality on the Github Page of Siegfried.

Siegfried was first publicly released the 28th february 2014 in version 0.1.

User Experiences[edit]

  • ZBW:
    • The command line tool is very easy to handle.
      The default output is yaml. This can be changed to csv or json.
      • Usual command: sf file.ext (will output in yaml)
      • Change output to csv: sf -csv file.ext
      • Change output to json: sf -json file.ext
    • It is also possible to save the output in an external file:
      • sf file.ext >output.yml
      • sf -csv file.ext >output.csv
      • sf -json file.ext >output.json

Development Activity[edit]

All development activity is visible on GitHub: http://github.com/richardlehane/siegfried/commits


Release Feed[edit]

Below the last 3 release feeds:

2024-07-15 02:36:25
[tag:github.com,2008:Repository/17277958/v1.11.2-rc0 Version 1.11.2-rc0]
by richardlehane
2024-06-28 00:38:41
[tag:github.com,2008:Repository/17277958/v1.11.1 Version 1.11.1]
by github-actions[bot]
2024-06-22 05:59:59
[tag:github.com,2008:Repository/17277958/bench-2024-06-22 bench-2024-06-22]
by richardlehane


Activity Feed[edit]

Below the last 5 commits:

2024-07-07 02:57:31
[tag:github.com,2008:Grit::Commit/5e86c0355bcf30bc74e75bc3c4d3ee8a3be35ab8 update deps]
by richardlehane https://github.com/richardlehane
2024-07-07 02:56:00
[tag:github.com,2008:Grit::Commit/a6021af5d5d0ed92da765d2b4fc9032fc52630d1 typos in changelog and readme]
by richardlehane https://github.com/richardlehane
2024-07-07 02:54:34
[tag:github.com,2008:Grit::Commit/4bf8d50c117bc6f838e6db950797afd43720925d Merge branch 'main' into develop]
by richardlehane https://github.com/richardlehane
2024-07-07 02:52:55
[tag:github.com,2008:Grit::Commit/4c770753df1d075f4ded1bd22aa12695f14f9432 git commit -a -m "allow automated releases to trigger workflows"]
by richardlehane https://github.com/richardlehane
2024-07-06 02:19:41
[tag:github.com,2008:Grit::Commit/3661848393c10d4e85f880e9e097e1e8ed9a7f57 Update README.md - fix wasm/README.md path in changelog (#252)]
by kieranjol https://github.com/kieranjol