xref: /src/contrib/file/python/README.md (revision f9c0a5128361f5d37b42cf46e8092ec58787fd17)
1ad1ba6e1SEitan Adler# `file-magic`: Python Bindings
2ad1ba6e1SEitan Adler
3ad1ba6e1SEitan AdlerThis library is a Python ctypes interface to `libmagic`.
4ad1ba6e1SEitan Adler
5ad1ba6e1SEitan Adler
6ad1ba6e1SEitan Adler## Installing
7ad1ba6e1SEitan Adler
8ad1ba6e1SEitan AdlerYou can install `file-magic` either with:
9ad1ba6e1SEitan Adler
10ad1ba6e1SEitan Adler    python setup.py install
11ad1ba6e1SEitan Adler    # or
12ad1ba6e1SEitan Adler    easy_install .
13ad1ba6e1SEitan Adler    # or
14ad1ba6e1SEitan Adler    pip install file-magic
15ad1ba6e1SEitan Adler
16ad1ba6e1SEitan Adler
17ad1ba6e1SEitan Adler## Using
18ad1ba6e1SEitan Adler
19ad1ba6e1SEitan Adler    import magic
20ad1ba6e1SEitan Adler
21ad1ba6e1SEitan Adler    detected = magic.detect_from_filename('magic.py')
22ad1ba6e1SEitan Adler    print 'Detected MIME type: {}'.format(detected.mime_type)
23ad1ba6e1SEitan Adler    print 'Detected encoding: {}'.format(detected.encoding)
24ad1ba6e1SEitan Adler    print 'Detected file type name: {}'.format(detected.name)
25ad1ba6e1SEitan Adler
26ad1ba6e1SEitan Adler
27ad1ba6e1SEitan Adler## Developing/Contributing
28ad1ba6e1SEitan Adler
29ad1ba6e1SEitan AdlerTo run the tests:
30ad1ba6e1SEitan Adler
31ad1ba6e1SEitan Adler    python setup.py test
32