diff options
| -rw-r--r-- | README.md | 42 |
1 files changed, 29 insertions, 13 deletions
@@ -42,18 +42,6 @@ You can also combine the flag options: 'text/plain' ``` -## Bug Reports - -python-magic is a thin layer over the libmagic C library. Historically, most bugs that have been reported against python-magic are actually bugs in libmagic; libmagic bugs can be reported on their tracker here: https://bugs.astron.com/my_view_page.php. If you're not sure where the bug lies feel free to file an issue on GitHub and I can triage it. - -## 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 python-magic is available on PyPI and @@ -64,6 +52,13 @@ Other sources: - PyPI: http://pypi.python.org/pypi/python-magic/ - GitHub: https://github.com/ahupp/python-magic +This module is a simple wrapper around the libmagic C library, and +that must be installed as well: + +### Debian/Ubuntu + + $ sudo apt-get install libmagic1 + ### Windows You'll need DLLs for libmagic. @julian-r has uploaded a version of this project that includes binaries to PyPI: @@ -74,7 +69,6 @@ Other sources of the libraries in the past have been [File for Windows](http://g If you are using a 64-bit build of python, you'll need 64-bit libmagic binaries which can be found here: https://github.com/pidydx/libmagicwin64. Newer version can be found here: https://github.com/nscaife/file-windows. - ### OSX - When using Homebrew: `brew install libmagic` @@ -94,6 +88,28 @@ If you are using a 64-bit build of python, you'll need 64-bit libmagic binaries - '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. + +## Bug Reports + +python-magic is a thin layer over the libmagic C library. +Historically, most bugs that have been reported against python-magic +are actually bugs in libmagic; libmagic bugs can be reported on their +tracker here: https://bugs.astron.com/my_view_page.php. If you're not +sure where the bug lies feel free to file an issue on GitHub and I can +triage it. + +## 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. + + ## Author Written by Adam Hupp in 2001 for a project that never got off the |