Python bindings for the XML Security Library

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bgaifullin from gravatar.com bgaifullin Avatar for hoefling from gravatar.com hoefling Avatar for mehcode from gravatar.com mehcode Avatar for mxamin from gravatar.com mxamin

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT)

Author: Bulat Gaifullin

Maintainer: Oleg Hoefling

Tags xmlsec

Requires: Python >=3.5

Classifiers

Project description

python-xmlsec

.. image:: https://img.shields.io/pypi/v/xmlsec.svg?logo=python&logoColor=white :target: https://pypi.python.org/pypi/xmlsec .. image:: https://results.pre-commit.ci/badge/github/xmlsec/python-xmlsec/master.svg :target: https://results.pre-commit.ci/latest/github/xmlsec/python-xmlsec/master :alt: pre-commit.ci status .. image:: https://img.shields.io/appveyor/ci/hoefling/xmlsec/master.svg?logo=appveyor&logoColor=white&label=AppVeyor :target: https://ci.appveyor.com/project/hoefling/xmlsec .. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml/badge.svg :target: https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml .. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml/badge.svg :target: https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml .. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml/badge.svg :target: https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml .. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml/badge.svg :target: https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml .. image:: https://codecov.io/gh/xmlsec/python-xmlsec/branch/master/graph/badge.svg :target: https://codecov.io/gh/xmlsec/python-xmlsec .. image:: https://img.shields.io/readthedocs/xmlsec/latest?logo=read-the-docs :target: https://xmlsec.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

Python bindings for the XML Security Library <https://www.aleksey.com/xmlsec/>_.

Documentation

A documentation for xmlsec can be found at xmlsec.readthedocs.io <https://xmlsec.readthedocs.io/>_.

Usage

Check the examples <https://xmlsec.readthedocs.io/en/latest/examples.html>_ section in the documentation to see various examples of signing and verifying using the library.

Requirements

  • libxml2 >= 2.9.1
  • libxmlsec1 >= 1.2.33

Install

xmlsec is available on PyPI:

.. code-block:: bash

pip install xmlsec

Depending on your OS, you may need to install the required native libraries first:

Linux (Debian) ^^^^^^^^^^^^^^

.. code-block:: bash

apt-get install pkg-config 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.

.. code-block:: bash

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

Linux (CentOS) ^^^^^^^^^^^^^^

.. code-block:: bash

yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel

Linux (Fedora) ^^^^^^^^^^^^^^

.. code-block:: bash

dnf install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel

Mac ^^^

.. code-block:: bash

brew install libxml2 libxmlsec1 pkg-config

Alpine ^^^^^^

.. code-block:: bash

apk add build-base libressl libffi-dev libressl-dev libxslt-dev libxml2-dev xmlsec-dev xmlsec

Troubleshooting

Mac ^^^

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

Windows ^^^^^^^

Starting with 1.3.7, prebuilt wheels are available for Windows, so running pip install xmlsec should suffice. If you want to build from source:

#. Configure build environment, see wiki.python.org <https://wiki.python.org/moin/WindowsCompilers>_ for more details.

#. Install from source dist:

.. code-block:: bash

  pip install xmlsec --no-binary=xmlsec

Building from source

#. Clone the xmlsec source code repository to your local computer.

.. code-block:: bash

  git clone https://github.com/xmlsec/python-xmlsec.git

#. Change into the python-xmlsec root directory.

.. code-block:: bash

  cd /path/to/xmlsec

#. Install the project and all its dependencies using pip.

.. code-block:: bash

  pip install .

Contributing

Setting up your environment ^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Follow steps 1 and 2 of the manual installation instructions <#building-from-source>_.

#. 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.

.. code-block:: bash

  mkvirtualenv xmlsec

The mkvirtualenv command is available from virtualenvwrapper package which can be installed by following link <http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation>_.

#. Activate the created virtual environment:

.. code-block:: bash

  workon xmlsec

#. Install xmlsec in development mode with testing enabled. This will download all dependencies required for running the unit tests.

.. code-block:: bash

  pip install -r requirements-test.txt
  pip install -e "."

Running the test suite ^^^^^^^^^^^^^^^^^^^^^^

#. Set up your environment <#setting-up-your-environment>_.

#. Run the unit tests.

.. code-block:: bash

  pytest tests

#. Tests configuration

Env variable PYXMLSEC_TEST_ITERATIONS specifies number of test iterations to detect memory leaks.

Reporting an issue ^^^^^^^^^^^^^^^^^^

Please attach the output of following information:

  • version of xmlsec

  • version of libxmlsec1

  • version of libxml2

  • output from the command

    .. code-block:: bash

    pkg-config --cflags xmlsec1

License

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 <http://opensource.org/licenses/MIT>_ for more information.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bgaifullin from gravatar.com bgaifullin Avatar for hoefling from gravatar.com hoefling Avatar for mehcode from gravatar.com mehcode Avatar for mxamin from gravatar.com mxamin

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT)

Author: Bulat Gaifullin

Maintainer: Oleg Hoefling

Tags xmlsec

Requires: Python >=3.5

Classifiers

Release history Release notifications | RSS feed

This version

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7 yanked

Reason this release was yanked:

See https://github.com/mehcode/python-xmlsec/issues/140

1.3.3

1.3.2

1.3.1

1.2.0

1.1.0

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.3.dev0 pre-release

1.0.2.dev0 pre-release

1.0.1

0.6.1

0.6.0

0.5.0

0.4.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2.0

0.1.2

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xmlsec-1.3.14.tar.gz (68.9 kB view hashes)

Uploaded Source

Built Distributions

xmlsec-1.3.14-cp312-cp312-win_amd64.whl (2.4 MB view hashes)

Uploaded CPython 3.12 Windows x86-64

xmlsec-1.3.14-cp312-cp312-win32.whl (2.1 MB view hashes)

Uploaded CPython 3.12 Windows x86

xmlsec-1.3.14-cp312-cp312-musllinux_1_1_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ x86-64

xmlsec-1.3.14-cp312-cp312-musllinux_1_1_aarch64.whl (4.3 MB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ ARM64

xmlsec-1.3.14-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.9 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

xmlsec-1.3.14-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl (3.6 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ i686

xmlsec-1.3.14-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ARM64

xmlsec-1.3.14-cp312-cp312-macosx_11_0_arm64.whl (3.7 MB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

xmlsec-1.3.14-cp312-cp312-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

xmlsec-1.3.14-cp311-cp311-win_amd64.whl (2.4 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

xmlsec-1.3.14-cp311-cp311-win32.whl (2.1 MB view hashes)

Uploaded CPython 3.11 Windows x86

xmlsec-1.3.14-cp311-cp311-musllinux_1_1_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ x86-64

xmlsec-1.3.14-cp311-cp311-musllinux_1_1_aarch64.whl (4.3 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ ARM64

xmlsec-1.3.14-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.9 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

xmlsec-1.3.14-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl (3.6 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686

xmlsec-1.3.14-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARM64

xmlsec-1.3.14-cp311-cp311-macosx_11_0_arm64.whl (3.7 MB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

xmlsec-1.3.14-cp311-cp311-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

xmlsec-1.3.14-cp310-cp310-win_amd64.whl (2.4 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

xmlsec-1.3.14-cp310-cp310-win32.whl (2.1 MB view hashes)

Uploaded CPython 3.10 Windows x86

xmlsec-1.3.14-cp310-cp310-musllinux_1_1_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ x86-64

xmlsec-1.3.14-cp310-cp310-musllinux_1_1_aarch64.whl (4.3 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ ARM64

xmlsec-1.3.14-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.9 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

xmlsec-1.3.14-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (3.6 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

xmlsec-1.3.14-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64

xmlsec-1.3.14-cp310-cp310-macosx_11_0_arm64.whl (3.7 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

xmlsec-1.3.14-cp310-cp310-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

xmlsec-1.3.14-cp39-cp39-win_amd64.whl (2.4 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

xmlsec-1.3.14-cp39-cp39-win32.whl (2.1 MB view hashes)

Uploaded CPython 3.9 Windows x86

xmlsec-1.3.14-cp39-cp39-musllinux_1_1_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ x86-64

xmlsec-1.3.14-cp39-cp39-musllinux_1_1_aarch64.whl (4.3 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ ARM64

xmlsec-1.3.14-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.9 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

xmlsec-1.3.14-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (3.6 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

xmlsec-1.3.14-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARM64

xmlsec-1.3.14-cp39-cp39-macosx_11_0_arm64.whl (3.7 MB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

xmlsec-1.3.14-cp39-cp39-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

xmlsec-1.3.14-cp38-cp38-win_amd64.whl (2.4 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

xmlsec-1.3.14-cp38-cp38-win32.whl (2.1 MB view hashes)

Uploaded CPython 3.8 Windows x86

xmlsec-1.3.14-cp38-cp38-musllinux_1_1_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ x86-64

xmlsec-1.3.14-cp38-cp38-musllinux_1_1_aarch64.whl (4.3 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ ARM64

xmlsec-1.3.14-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.9 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

xmlsec-1.3.14-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (3.6 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

xmlsec-1.3.14-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARM64

xmlsec-1.3.14-cp38-cp38-macosx_11_0_arm64.whl (3.7 MB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

xmlsec-1.3.14-cp38-cp38-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

xmlsec-1.3.14-cp37-cp37m-win_amd64.whl (2.4 MB view hashes)

Uploaded CPython 3.7m Windows x86-64

xmlsec-1.3.14-cp37-cp37m-win32.whl (2.1 MB view hashes)

Uploaded CPython 3.7m Windows x86

xmlsec-1.3.14-cp37-cp37m-musllinux_1_1_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.7m musllinux: musl 1.1+ x86-64

xmlsec-1.3.14-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.9 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

xmlsec-1.3.14-cp37-cp37m-manylinux_2_17_i686.manylinux2014_i686.whl (3.6 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ i686

xmlsec-1.3.14-cp37-cp37m-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

xmlsec-1.3.14-cp36-cp36m-win_amd64.whl (2.4 MB view hashes)

Uploaded CPython 3.6m Windows x86-64

xmlsec-1.3.14-cp36-cp36m-win32.whl (2.1 MB view hashes)

Uploaded CPython 3.6m Windows x86

xmlsec-1.3.14-cp36-cp36m-musllinux_1_1_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.6m musllinux: musl 1.1+ x86-64

xmlsec-1.3.14-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.9 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ x86-64

xmlsec-1.3.14-cp36-cp36m-manylinux_2_17_i686.manylinux2014_i686.whl (3.6 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ i686

xmlsec-1.3.14-cp36-cp36m-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.6m macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page