Skip to content

Commit d3abfd7

Browse files
authored
generalize and reduce the new doc section
1 parent d5248ac commit d3abfd7

1 file changed

Lines changed: 10 additions & 25 deletions

File tree

README.rst

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,21 @@ Installation
1414
Compatibility
1515
=============
1616

17+
python
18+
------
19+
1720
python-libarchive-c is currently tested with python 2.7, 3.4, 3.5, and 3.6.
1821

1922
If you find an incompatibility with older versions you can send us a small patch,
2023
but we won't accept big changes.
2124

25+
libarchive
26+
----------
27+
28+
python-libarchive-c may not work properly with obsolete versions of libarchive such as the ones included in MacOS. In that case you can install a recent version of libarchive (e.g. with ``brew install libarchive`` on MacOS) and use the ``LIBARCHIVE`` environment variable to point python-libarchive-c to it::
29+
30+
export LIBARCHIVE=/usr/local/Cellar/libarchive/3.3.3/lib/libarchive.13.dylib
31+
2232
Usage
2333
=====
2434

@@ -53,31 +63,6 @@ file descriptor, and ``custom_writer`` sends the data to a callback function.
5363

5464
You can also find more thorough examples in the ``tests/`` directory.
5565

56-
MacOS Notes
57-
===========
58-
MacOS ships with an old version of libarchive (/usr/lib/libarchive.dylib) and python-libarchive-c will by default try and use it.
59-
If you want to use python-libarchive-c on MacOS, you need to install a newer version of this lib. Homebrew can do this::
60-
61-
$ brew install libarchive
62-
63-
This will install it in a path like /usr/local/Cellar/libarchive/3.3.3/lib/libarchive.13.dylib .
64-
65-
Once installed, set the environment variable LIBARCHIVE to this path::
66-
67-
export LIBARCHIVE=/usr/local/Cellar/libarchive/3.3.3/lib/libarchive.13.dylib
68-
python
69-
70-
or alternatively inline with starting Python::
71-
72-
LIBARCHIVE=/usr/local/Cellar/libarchive/3.3.3/lib/libarchive.13.dylib python
73-
74-
or inside the script itself::
75-
76-
python
77-
>>> import os
78-
>>> os.environ['LIBARCHIVE']='/usr/local/Cellar/libarchive/3.3.3/lib/libarchive.13.dylib'
79-
80-
8166
License
8267
=======
8368

0 commit comments

Comments
 (0)