summaryrefslogtreecommitdiffstats
path: root/python/python3-puremagic/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python3-puremagic/README')
-rw-r--r--python/python3-puremagic/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/python/python3-puremagic/README b/python/python3-puremagic/README
new file mode 100644
index 0000000000..1835595d3e
--- /dev/null
+++ b/python/python3-puremagic/README
@@ -0,0 +1,24 @@
+puremagic is a pure python module that will identify a file based off
+it's magic numbers.
+
+It is designed to be minimalistic and inherently cross platform
+compatible. It is also designed to be a stand in for python-magic, it
+incorporates the functions from_file(filename[, mime]) and
+from_string(string[, mime]) however the magic_file() and magic_string()
+are more powerful and will also display confidence and duplicate
+matches.
+
+It does NOT try to match files off non-magic string. In other words it
+will not search for a string within a certain window of bytes like
+others might.
+
+Advantages over using a wrapper for 'file' or 'libmagic':
+ * Faster
+ * Lightweight
+ * Cross platform compatible
+ * No dependencies
+
+Disadvantages:
+ * Does not have as many file types
+ * No multilingual comments
+ * Duplications due to small or reused magic numbers