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