Skip to content

Commit 825f2c6

Browse files
committed
update installation notes in docs
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
1 parent 7b3af14 commit 825f2c6

File tree

2 files changed

+72
-41
lines changed

2 files changed

+72
-41
lines changed

README.rst

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ Install
4141
4242
pip install xmlsec
4343
44-
Prerequisites
45-
-------------
44+
Depending on your OS, you may need to install the required native
45+
libraries first:
4646

4747
Linux (Debian)
4848
^^^^^^^^^^^^^^
@@ -71,6 +71,14 @@ Linux (CentOS)
7171
yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
7272
7373
74+
Linux (Fedora)
75+
^^^^^^^^^^^^^^
76+
77+
.. code-block:: bash
78+
79+
dnf install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
80+
81+
7482
Mac
7583
^^^
7684

@@ -86,8 +94,9 @@ Alpine
8694
8795
apk add build-base libressl libffi-dev libressl-dev libxslt-dev libxml2-dev xmlsec-dev xmlsec
8896
97+
8998
Troubleshooting
90-
---------------
99+
***************
91100

92101
Mac
93102
^^^
@@ -114,9 +123,9 @@ to build from source:
114123
115124
116125
Building from source
117-
--------------------
126+
********************
118127

119-
#. Clone the ``xmlsec`` repository to your local computer.
128+
#. Clone the ``xmlsec`` source code repository to your local computer.
120129

121130
.. code-block:: bash
122131
@@ -140,9 +149,9 @@ Contributing
140149
************
141150

142151
Setting up your environment
143-
---------------------------
152+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
144153

145-
#. Follow steps 1 and 2 of the `manual installation instructions <#manual>`_.
154+
#. Follow steps 1 and 2 of the `manual installation instructions <#building-from-source>`_.
146155

147156

148157
#. Initialize a virtual environment to develop in.
@@ -171,7 +180,7 @@ Setting up your environment
171180
172181
173182
Running the test suite
174-
----------------------
183+
^^^^^^^^^^^^^^^^^^^^^^
175184

176185
#. `Set up your environment <#setting-up-your-environment>`_.
177186

@@ -187,7 +196,7 @@ Running the test suite
187196
test iterations to detect memory leaks.
188197

189198
Reporting an issue
190-
------------------
199+
^^^^^^^^^^^^^^^^^^
191200

192201
Please attach the output of following information:
193202

doc/source/install.rst

Lines changed: 54 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,89 @@
1-
Install
2-
-----------
1+
Installation
2+
============
33

4-
Linux (Debian)
5-
^^^^^^^^^^^^^^
4+
``xmlsec`` is available on PyPI:
65

76
.. code-block:: bash
87
9-
apt-get install libxml2-dev libxmlsec1-dev libxmlsec1-openssl
10-
pip install xmlsec
8+
pip install xmlsec
119
10+
Depending on your OS, you may need to install the required native
11+
libraries first:
1212

13-
Note: There is no required version of libxml2 for ubuntu precise,
14-
so need to download and install it manually.
13+
Linux (Debian)
14+
--------------
1515

1616
.. code-block:: bash
1717
18-
wget http://xmlsoft.org/sources/libxml2-2.9.1.tar.gz
19-
tar -xvf libxml2-2.9.1.tar.gz
20-
cd libxml2-2.9.1
21-
./configure && make && make install
18+
apt-get install libxml2-dev libxmlsec1-dev libxmlsec1-openssl
19+
20+
.. note:: There is no required version of LibXML2 for Ubuntu Precise,
21+
so you need to download and install it manually:
22+
23+
.. code-block:: bash
24+
25+
wget http://xmlsoft.org/sources/libxml2-2.9.1.tar.gz
26+
tar -xvf libxml2-2.9.1.tar.gz
27+
cd libxml2-2.9.1
28+
./configure && make && make install
2229
2330
2431
Linux (CentOS)
25-
^^^^^^^^^^^^^^
32+
--------------
2633

2734
.. code-block:: bash
2835
29-
yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
30-
pip install xmlsec
36+
yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
37+
38+
39+
Linux (Fedora)
40+
--------------
41+
42+
.. code-block:: bash
43+
44+
dnf install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
3145
3246
3347
Mac
34-
^^^
48+
---
3549

3650
.. code-block:: bash
3751
38-
xcode-select --install
39-
brew upgrade
40-
brew install libxml2 libxmlsec1 pkg-config
41-
pip install xmlsec
52+
xcode-select --install
53+
brew upgrade
54+
brew install libxml2 libxmlsec1 pkg-config
4255
4356
57+
Alpine
58+
------
4459

45-
Windows (Wheel)
46-
^^^^^^^^^^^^^^^
60+
.. code-block:: bash
4761
48-
#. Download appropriate binary wheels from `appveyor <https://ci.appveyor.com/project/bgaifullin/python-xmlsec>`_ (see build`s artifacts).
62+
apk add build-base libressl libffi-dev libressl-dev libxslt-dev libxml2-dev xmlsec-dev xmlsec
4963
50-
#. Install downloaded wheel
5164
52-
.. code-block:: bash
65+
Troubleshooting
66+
***************
5367

54-
pip install <downloaded wheel filename>
68+
Mac
69+
---
5570

71+
If you get any fatal errors about missing ``.h`` files, update your
72+
``C_INCLUDE_PATH`` environment variable to include the appropriate
73+
files from the ``libxml2`` and ``libxmlsec1`` libraries.
5674

57-
Windows (pip)
58-
^^^^^^^^^^^^^
5975

60-
#. Configure build environment, see `wiki.python.org <https://wiki.python.org/moin/WindowsCompilers>`_ for more details.
76+
Windows
77+
-------
78+
79+
Starting with 1.3.7, prebuilt wheels are available for Windows,
80+
so running ``pip install xmlsec`` should suffice. If you want
81+
to build from source:
6182

62-
#. Install from pip
83+
#. Configure build environment, see `wiki.python.org <https://wiki.python.org/moin/WindowsCompilers>`_ for more details.
6384

64-
.. code-block:: bash
85+
#. Install from source dist:
6586

66-
pip install xmlsec
87+
.. code-block:: bash
6788
89+
pip install xmlsec --no-binary=xmlsec

0 commit comments

Comments
 (0)