summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZach Seils <seils@cisco.com>2014-11-10 00:28:58 -0500
committerZach Seils <seils@cisco.com>2014-11-10 00:28:58 -0500
commit6bc72cf260f1372f76d3e679287b7780ee4f1d3a (patch)
treef90db9c8c69520f16157568ac07f22fd8cced413 /README.md
parent012f8a90501d314a694c136b73179af12b2f41e8 (diff)
downloadpython-magic-6bc72cf260f1372f76d3e679287b7780ee4f1d3a.tar.gz
Add support for MAGIC_COMPRESS through Magic constructor.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/README.md b/README.md
index dc56edd..3b422f3 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,21 @@ functionality is exposed to the command line by the Unix command
There is also a `Magic` class that provides more direct control,
including overriding the magic database file and turning on character
-encoding dectection. This is not recommended for general use. In
-particular, it its not safe for sharing across multiple threads and
+encoding detection. This is not recommended for general use. In
+particular, it's not safe for sharing across multiple threads and
will fail throw if this is attempted.
+ >>> f = magic.Magic(uncompress=True)
+ >>> f.from_file('testdata/test.gz')
+ 'ASCII text (gzip compressed data, was "test", last modified: Sat Jun 28
+ 21:32:52 2008, from Unix)'
+
+You can also combine the flag options:
+
+ >>> f = magic.Magic(mime=True, uncompress=True)
+ >>> f.from_file('testdata/test.gz')
+ 'text/plain'
+
## Installation
The current stable version of python-magic is available on pypi and
@@ -54,12 +65,12 @@ On OSX:
Attempting to run the 32-bit libmagic DLL in a 64-bit build of
python will fail with this error. I'm not aware of any publically
available 64-bit builds of libmagic. You'll either need to build
- them yourself (pleae share docs!), or switch to a 32-bit Python.
+ them yourself (please share docs!), or switch to a 32-bit Python.
## Author
Written by Adam Hupp in 2001 for a project that never got off the
-ground. It origionally used SWIG for the C library bindings, but
+ground. It originally used SWIG for the C library bindings, but
switched to ctypes once that was part of the python standard library.
You can contact me via my [website](http://hupp.org/adam) or