Python bindings for the XML Security Library.
A documentation for
xmlsec can be found at xmlsec.readthedocs.io.
Check the examples section in the documentation to see various examples of signing and verifying using the library.
libxml2 >= 2.9.1
libxmlsec1 >= 1.2.18
xmlsec is available on PyPI:
pip install xmlsec
Depending on your OS, you may need to install the required native libraries first:
apt-get install libxml2-dev libxmlsec1-dev libxmlsec1-openssl
Note: There is no required version of LibXML2 for Ubuntu Precise, so you need to download and install it manually.
wget http://xmlsoft.org/sources/libxml2-2.9.1.tar.gz tar -xvf libxml2-2.9.1.tar.gz cd libxml2-2.9.1 ./configure && make && make install
yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
dnf install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
brew install libxml2 libxmlsec1 pkg-config
apk add build-base libressl libffi-dev libressl-dev libxslt-dev libxml2-dev xmlsec-dev xmlsec
If you get any fatal errors about missing
.h files, update your
C_INCLUDE_PATH environment variable to include the appropriate
files from the
Starting with 1.3.7, prebuilt wheels are available for Windows,
pip install xmlsec should suffice. If you want
to build from source:
Configure build environment, see wiki.python.org for more details.
Install from source dist:
pip install xmlsec --no-binary=xmlsec
Building from source
xmlsecsource code repository to your local computer.
git clone https://github.com/mehcode/python-xmlsec.git
Change into the
Install the project and all its dependencies using
pip install .
Setting up your environment
Follow steps 1 and 2 of the manual installation instructions.
Initialize a virtual environment to develop in. This is done so as to ensure every contributor is working with close-to-identicial versions of packages.
mkvirtualenvcommand is available from
virtualenvwrapperpackage which can be installed by following link.
Activate the created virtual environment:
xmlsecin development mode with testing enabled. This will download all dependencies required for running the unit tests.
pip install -r requirements-test.txt pip install -e "."
Running the test suite
Run the unit tests.
PYXMLSEC_TEST_ITERATIONSspecifies number of test iterations to detect memory leaks.
Reporting an issue
Please attach the output of following information:
output from the command
pkg-config --cflags xmlsec1
Unless otherwise noted, all files contained within this project are licensed under the MIT opensource license.
See the included
LICENSE file or visit opensource.org for more information.