Metadata-Version: 2.1
Name: magicfile
Version: 0.4.22
Summary: File type identification using libmagic
Home-page: http://github.com/messense/magicfile
Author: Adam Hupp
Author-email: adam@hupp.org
License: MIT
Description: # magicfile (A CFFI fork of python-magic)
        [![PyPI version](https://badge.fury.io/py/magicfile.svg)](https://badge.fury.io/py/magicfile)
        
        magicfile is a python interface to the libmagic file type
        identification library.  libmagic identifies file types by checking
        their headers according to a predefined list of file types. This
        functionality is exposed to the command line by the Unix command
        `file`.
        
        ## Usage
        
        ```python
        >>> import magicfile as magic
        >>> magic.from_file("testdata/test.pdf")
        'PDF document, version 1.2'
        >>> magic.from_buffer(open("testdata/test.pdf").read(1024))
        'PDF document, version 1.2'
        >>> magic.from_file("testdata/test.pdf", mime=True)
        'application/pdf'
        ```
        
        There is also a `Magic` class that provides more direct control,
        including overriding the magic database file and turning on character
        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.
        
        ```python
        >>> 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:
        
        ```python
        >>> f = magic.Magic(mime=True, uncompress=True)
        >>> f.from_file('testdata/test.gz')
        'text/plain'
        ```
        
        ## Versioning
        
        Minor version bumps should be backwards compatible.  Major bumps are not.
        
        ## Name Conflict
        
        There are, sadly, two libraries which use the module name `magic`.  Both have been around for quite a while.If you are using this module and get an error using a method like `open`, your code is expecting the other one.  Hopefully one day these will be reconciled.
        
        ## Installation
        
        The current stable version of magicfile is available on pypi and
        can be installed by running `pip install magicfile`.
        
        Other sources:
        
        - pypi: http://pypi.python.org/pypi/magicfile/
        - github: https://github.com/messense/magicfile
        
        ### Troubleshooting
        
        - 'MagicException: could not find any magic files!': some
          installations of libmagic do not correctly point to their magic
          database file.  Try specifying the path to the file explicitly in the
          constructor: `magic.Magic(magic_file="path_to_magic_file")`.
        
        - 'WindowsError: [Error 193] %1 is not a valid Win32 application':
          Attempting to run the 32-bit libmagic DLL in a 64-bit build of
          python will fail with this error.  Here are 64-bit builds of libmagic for windows: https://github.com/pidydx/libmagicwin64
        
        - 'WindowsError: exception: access violation writing 0x00000000 ' This may indicate you are mixing 
          Windows Python and Cygwin Python. Make sure your libmagic and python builds are consistent.
        
        ## Author
        
        Written by Adam Hupp in 2001 for a project that never got off the
        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
        [github](http://github.com/ahupp).
        
        ## Contributors
        
        Thanks to these folks on github who submitted features and bugfixes.
        
        -   Amit Sethi
        -   [bigben87](https://github.com/bigben87)
        -   [fallgesetz](https://github.com/fallgesetz)
        -   [FlaPer87](https://github.com/FlaPer87)
        -   [lukenowak](https://github.com/lukenowak)
        -   NicolasDelaby
        -   sacha@ssl.co.uk
        -   SimpleSeb
        -   [tehmaze](https://github.com/tehmaze)
        
        ## License
        
        magicfile is distributed under the MIT license.  See the included
        LICENSE file for details.
        
        
Keywords: mime magic file
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/markdown
