xmlsec 1.3.13__tar.gz → 1.3.15__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {xmlsec-1.3.13 → xmlsec-1.3.15}/.pre-commit-config.yaml +7 -7
- xmlsec-1.3.15/PKG-INFO +277 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/README.rst +21 -12
- {xmlsec-1.3.13 → xmlsec-1.3.15}/pyproject.toml +43 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/setup.cfg +3 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/setup.py +147 -49
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/common.h +1 -1
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/constants.c +9 -4
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/enc.c +14 -2
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/keys.c +57 -1
- xmlsec-1.3.15/src/lxml.c +131 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/lxml.h +9 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/main.c +59 -4
- {xmlsec-1.3.13/src/xmlsec.egg-info → xmlsec-1.3.15/src/python_xmlsec1.egg-info}/PKG-INFO +21 -14
- xmlsec-1.3.15/src/python_xmlsec1.egg-info/SOURCES.txt +103 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15/src/pyxmlsec.egg-info}/PKG-INFO +21 -14
- {xmlsec-1.3.13/src/xmlsec.egg-info → xmlsec-1.3.15/src/pyxmlsec.egg-info}/SOURCES.txt +20 -11
- xmlsec-1.3.15/src/pyxmlsec.egg-info/dependency_links.txt +1 -0
- xmlsec-1.3.15/src/pyxmlsec.egg-info/not-zip-safe +1 -0
- xmlsec-1.3.15/src/pyxmlsec.egg-info/requires.txt +1 -0
- xmlsec-1.3.15/src/pyxmlsec.egg-info/top_level.txt +1 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/xmlsec/__init__.pyi +5 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/xmlsec/constants.pyi +1 -2
- xmlsec-1.3.15/src/xmlsec.cpython-39-darwin.so +0 -0
- xmlsec-1.3.15/src/xmlsec.egg-info/PKG-INFO +277 -0
- xmlsec-1.3.15/src/xmlsec.egg-info/SOURCES.txt +103 -0
- xmlsec-1.3.15/src/xmlsec.egg-info/dependency_links.txt +1 -0
- xmlsec-1.3.15/src/xmlsec.egg-info/not-zip-safe +1 -0
- xmlsec-1.3.15/src/xmlsec.egg-info/requires.txt +1 -0
- xmlsec-1.3.15/src/xmlsec.egg-info/top_level.txt +1 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/base.py +8 -23
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/conftest.py +3 -2
- xmlsec-1.3.15/tests/data/sign5-out-xmlsec_1_2_36_to_37.xml +67 -0
- xmlsec-1.3.15/tests/softhsm_setup.py +332 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_ds.py +6 -3
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_enc.py +4 -24
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_main.py +2 -2
- xmlsec-1.3.15/tests/test_pkcs11.py +57 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_xmlsec.py +3 -3
- xmlsec-1.3.13/src/lxml.c +0 -43
- xmlsec-1.3.13/tests/data/enc-bad-in.xml +0 -208
- {xmlsec-1.3.13 → xmlsec-1.3.15}/.readthedocs.yaml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/LICENSE +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/MANIFEST.in +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/constants.h +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/debug.h +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/ds.c +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/exception.c +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/exception.h +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/keys.h +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/platform.h +0 -0
- {xmlsec-1.3.13/src/xmlsec.egg-info → xmlsec-1.3.15/src/python_xmlsec1.egg-info}/dependency_links.txt +0 -0
- {xmlsec-1.3.13/src/xmlsec.egg-info → xmlsec-1.3.15/src/python_xmlsec1.egg-info}/not-zip-safe +0 -0
- {xmlsec-1.3.13/src/xmlsec.egg-info → xmlsec-1.3.15/src/python_xmlsec1.egg-info}/requires.txt +0 -0
- {xmlsec-1.3.13/src/xmlsec.egg-info → xmlsec-1.3.15/src/python_xmlsec1.egg-info}/top_level.txt +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/template.c +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/tree.c +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/utils.c +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/utils.h +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/xmlsec/py.typed +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/xmlsec/template.pyi +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/src/xmlsec/tree.pyi +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/__init__.py +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/deskey.bin +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/doc.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/dsacert.der +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/dsakey.der +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/enc1-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/enc1-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/enc2-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/enc2-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/enc3-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/enc3-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/enc_template.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/rsacert.pem +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/rsakey.pem +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/rsapub.pem +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign1-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign1-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign2-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign2-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign3-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign3-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign4-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign4-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign5-in.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign5-out.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign6-in.bin +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign6-out.bin +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/data/sign_template.xml +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_constants.py +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_doc_examples.py +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_keys.py +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_templates.py +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_tree.py +0 -0
- {xmlsec-1.3.13 → xmlsec-1.3.15}/tests/test_type_stubs.py +0 -0
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
# See https://pre-commit.com for more information
|
|
2
2
|
# See https://pre-commit.com/hooks.html for more hooks
|
|
3
|
-
exclude: ".*.diff" # exclude patches
|
|
4
3
|
repos:
|
|
5
4
|
- repo: https://github.com/psf/black
|
|
6
|
-
rev:
|
|
5
|
+
rev: 24.3.0
|
|
7
6
|
hooks:
|
|
8
7
|
- id: black
|
|
9
8
|
types: []
|
|
10
9
|
files: ^.*.pyi?$
|
|
11
10
|
exclude: ^doc/
|
|
12
11
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
13
|
-
rev: v4.
|
|
12
|
+
rev: v4.6.0
|
|
14
13
|
hooks:
|
|
15
14
|
- id: no-commit-to-branch
|
|
16
15
|
- id: trailing-whitespace
|
|
@@ -21,21 +20,22 @@ repos:
|
|
|
21
20
|
- id: check-merge-conflict
|
|
22
21
|
- id: check-json
|
|
23
22
|
- id: detect-private-key
|
|
23
|
+
exclude: ^.*/rsakey.pem$
|
|
24
24
|
- id: mixed-line-ending
|
|
25
25
|
- id: pretty-format-json
|
|
26
26
|
args: [--autofix]
|
|
27
27
|
- repo: https://github.com/PyCQA/flake8
|
|
28
|
-
rev:
|
|
28
|
+
rev: 7.0.0
|
|
29
29
|
hooks:
|
|
30
30
|
- id: flake8
|
|
31
31
|
exclude: ^setup.py$
|
|
32
32
|
additional_dependencies: [flake8-docstrings, flake8-bugbear, flake8-logging-format, flake8-builtins, flake8-eradicate, flake8-fixme, pep8-naming, flake8-pep3101, flake8-annotations-complexity,flake8-pyi]
|
|
33
33
|
- repo: https://github.com/PyCQA/isort
|
|
34
|
-
rev: 5.
|
|
34
|
+
rev: 5.13.2
|
|
35
35
|
hooks:
|
|
36
36
|
- id: isort
|
|
37
37
|
- repo: https://github.com/pre-commit/mirrors-mypy
|
|
38
|
-
rev:
|
|
38
|
+
rev: v1.9.0
|
|
39
39
|
hooks:
|
|
40
40
|
- id: mypy
|
|
41
41
|
exclude: (setup.py|tests/.*.py|doc/.*)
|
|
@@ -43,6 +43,6 @@ repos:
|
|
|
43
43
|
files: ^.*.pyi?$
|
|
44
44
|
additional_dependencies: [lxml-stubs,types-docutils]
|
|
45
45
|
- repo: https://github.com/pre-commit/pygrep-hooks
|
|
46
|
-
rev: v1.
|
|
46
|
+
rev: v1.10.0
|
|
47
47
|
hooks:
|
|
48
48
|
- id: rst-backticks
|
xmlsec-1.3.15/PKG-INFO
ADDED
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: xmlsec
|
|
3
|
+
Version: 1.3.15
|
|
4
|
+
Summary: Python bindings for the XML Security Library
|
|
5
|
+
Home-page: https://github.com/mehcode/python-xmlsec
|
|
6
|
+
Author: Bulat Gaifullin
|
|
7
|
+
Author-email: support@mehcode.com
|
|
8
|
+
Maintainer: Oleg Hoefling
|
|
9
|
+
Maintainer-email: oleg.hoefling@gmail.com
|
|
10
|
+
License: MIT
|
|
11
|
+
Project-URL: Documentation, https://xmlsec.readthedocs.io
|
|
12
|
+
Project-URL: Source, https://github.com/mehcode/python-xmlsec
|
|
13
|
+
Project-URL: Changelog, https://github.com/mehcode/python-xmlsec/releases
|
|
14
|
+
Keywords: xmlsec
|
|
15
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Intended Audience :: System Administrators
|
|
18
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
19
|
+
Classifier: Operating System :: OS Independent
|
|
20
|
+
Classifier: Programming Language :: C
|
|
21
|
+
Classifier: Programming Language :: Python :: 3
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.5
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.6
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
25
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
27
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
28
|
+
Classifier: Topic :: Text Processing :: Markup :: XML
|
|
29
|
+
Classifier: Typing :: Typed
|
|
30
|
+
Requires-Python: >=3.5
|
|
31
|
+
Description-Content-Type: text/markdown
|
|
32
|
+
License-File: LICENSE
|
|
33
|
+
Requires-Dist: lxml>=3.8
|
|
34
|
+
Dynamic: author
|
|
35
|
+
Dynamic: author-email
|
|
36
|
+
Dynamic: classifier
|
|
37
|
+
Dynamic: description
|
|
38
|
+
Dynamic: description-content-type
|
|
39
|
+
Dynamic: home-page
|
|
40
|
+
Dynamic: keywords
|
|
41
|
+
Dynamic: license
|
|
42
|
+
Dynamic: maintainer
|
|
43
|
+
Dynamic: maintainer-email
|
|
44
|
+
Dynamic: project-url
|
|
45
|
+
Dynamic: requires-dist
|
|
46
|
+
Dynamic: requires-python
|
|
47
|
+
Dynamic: summary
|
|
48
|
+
|
|
49
|
+
python-xmlsec
|
|
50
|
+
=============
|
|
51
|
+
|
|
52
|
+
.. image:: https://img.shields.io/pypi/v/xmlsec.svg?logo=python&logoColor=white
|
|
53
|
+
:target: https://pypi.python.org/pypi/xmlsec
|
|
54
|
+
.. image:: https://results.pre-commit.ci/badge/github/xmlsec/python-xmlsec/master.svg
|
|
55
|
+
:target: https://results.pre-commit.ci/latest/github/xmlsec/python-xmlsec/master
|
|
56
|
+
:alt: pre-commit.ci status
|
|
57
|
+
.. image:: https://img.shields.io/appveyor/ci/hoefling/xmlsec/master.svg?logo=appveyor&logoColor=white&label=AppVeyor
|
|
58
|
+
:target: https://ci.appveyor.com/project/hoefling/xmlsec
|
|
59
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml/badge.svg
|
|
60
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml
|
|
61
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml/badge.svg
|
|
62
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml
|
|
63
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml/badge.svg
|
|
64
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml
|
|
65
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml/badge.svg
|
|
66
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml
|
|
67
|
+
.. image:: https://codecov.io/gh/xmlsec/python-xmlsec/branch/master/graph/badge.svg
|
|
68
|
+
:target: https://codecov.io/gh/xmlsec/python-xmlsec
|
|
69
|
+
.. image:: https://img.shields.io/readthedocs/xmlsec/latest?logo=read-the-docs
|
|
70
|
+
:target: https://xmlsec.readthedocs.io/en/latest/?badge=latest
|
|
71
|
+
:alt: Documentation Status
|
|
72
|
+
|
|
73
|
+
Python bindings for the `XML Security Library <https://www.aleksey.com/xmlsec/>`_.
|
|
74
|
+
|
|
75
|
+
Documentation
|
|
76
|
+
*************
|
|
77
|
+
|
|
78
|
+
A documentation for ``xmlsec`` can be found at `xmlsec.readthedocs.io <https://xmlsec.readthedocs.io/>`_.
|
|
79
|
+
|
|
80
|
+
Usage
|
|
81
|
+
*****
|
|
82
|
+
|
|
83
|
+
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.
|
|
84
|
+
|
|
85
|
+
Requirements
|
|
86
|
+
************
|
|
87
|
+
- ``libxml2 >= 2.9.1``
|
|
88
|
+
- ``libxmlsec1 >= 1.2.33``
|
|
89
|
+
|
|
90
|
+
Install
|
|
91
|
+
*******
|
|
92
|
+
|
|
93
|
+
``xmlsec`` is available on PyPI:
|
|
94
|
+
|
|
95
|
+
.. code-block:: bash
|
|
96
|
+
|
|
97
|
+
pip install xmlsec
|
|
98
|
+
|
|
99
|
+
Depending on your OS, you may need to install the required native
|
|
100
|
+
libraries first:
|
|
101
|
+
|
|
102
|
+
Linux (Debian)
|
|
103
|
+
^^^^^^^^^^^^^^
|
|
104
|
+
|
|
105
|
+
.. code-block:: bash
|
|
106
|
+
|
|
107
|
+
apt-get install pkg-config libxml2-dev libxmlsec1-dev libxmlsec1-openssl
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
Note: There is no required version of LibXML2 for Ubuntu Precise,
|
|
111
|
+
so you need to download and install it manually.
|
|
112
|
+
|
|
113
|
+
.. code-block:: bash
|
|
114
|
+
|
|
115
|
+
wget http://xmlsoft.org/sources/libxml2-2.9.1.tar.gz
|
|
116
|
+
tar -xvf libxml2-2.9.1.tar.gz
|
|
117
|
+
cd libxml2-2.9.1
|
|
118
|
+
./configure && make && make install
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
Linux (CentOS)
|
|
122
|
+
^^^^^^^^^^^^^^
|
|
123
|
+
|
|
124
|
+
.. code-block:: bash
|
|
125
|
+
|
|
126
|
+
yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
Linux (Fedora)
|
|
130
|
+
^^^^^^^^^^^^^^
|
|
131
|
+
|
|
132
|
+
.. code-block:: bash
|
|
133
|
+
|
|
134
|
+
dnf install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
Mac
|
|
138
|
+
^^^
|
|
139
|
+
|
|
140
|
+
.. code-block:: bash
|
|
141
|
+
|
|
142
|
+
brew install libxml2 libxmlsec1 pkg-config
|
|
143
|
+
|
|
144
|
+
or
|
|
145
|
+
|
|
146
|
+
.. code-block:: bash
|
|
147
|
+
|
|
148
|
+
port install libxml2 xmlsec pkgconfig
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
Alpine
|
|
152
|
+
^^^^^^
|
|
153
|
+
|
|
154
|
+
.. code-block:: bash
|
|
155
|
+
|
|
156
|
+
apk add build-base libressl libffi-dev libressl-dev libxslt-dev libxml2-dev xmlsec-dev xmlsec
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
Troubleshooting
|
|
160
|
+
***************
|
|
161
|
+
|
|
162
|
+
Mac
|
|
163
|
+
^^^
|
|
164
|
+
|
|
165
|
+
If you get any fatal errors about missing ``.h`` files, update your
|
|
166
|
+
``C_INCLUDE_PATH`` environment variable to include the appropriate
|
|
167
|
+
files from the ``libxml2`` and ``libxmlsec1`` libraries.
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
Windows
|
|
171
|
+
^^^^^^^
|
|
172
|
+
|
|
173
|
+
Starting with 1.3.7, prebuilt wheels are available for Windows,
|
|
174
|
+
so running ``pip install xmlsec`` should suffice. If you want
|
|
175
|
+
to build from source:
|
|
176
|
+
|
|
177
|
+
#. Configure build environment, see `wiki.python.org <https://wiki.python.org/moin/WindowsCompilers>`_ for more details.
|
|
178
|
+
|
|
179
|
+
#. Install from source dist:
|
|
180
|
+
|
|
181
|
+
.. code-block:: bash
|
|
182
|
+
|
|
183
|
+
pip install xmlsec --no-binary=xmlsec
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
Building from source
|
|
187
|
+
********************
|
|
188
|
+
|
|
189
|
+
#. Clone the ``xmlsec`` source code repository to your local computer.
|
|
190
|
+
|
|
191
|
+
.. code-block:: bash
|
|
192
|
+
|
|
193
|
+
git clone https://github.com/xmlsec/python-xmlsec.git
|
|
194
|
+
|
|
195
|
+
#. Change into the ``python-xmlsec`` root directory.
|
|
196
|
+
|
|
197
|
+
.. code-block:: bash
|
|
198
|
+
|
|
199
|
+
cd /path/to/xmlsec
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
#. Install the project and all its dependencies using ``pip``.
|
|
203
|
+
|
|
204
|
+
.. code-block:: bash
|
|
205
|
+
|
|
206
|
+
pip install .
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
Contributing
|
|
210
|
+
************
|
|
211
|
+
|
|
212
|
+
Setting up your environment
|
|
213
|
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
214
|
+
|
|
215
|
+
#. Follow steps 1 and 2 of the `manual installation instructions <#building-from-source>`_.
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
#. Initialize a virtual environment to develop in.
|
|
219
|
+
This is done so as to ensure every contributor is working with
|
|
220
|
+
close-to-identicial versions of packages.
|
|
221
|
+
|
|
222
|
+
.. code-block:: bash
|
|
223
|
+
|
|
224
|
+
mkvirtualenv xmlsec
|
|
225
|
+
|
|
226
|
+
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>`_.
|
|
227
|
+
|
|
228
|
+
#. Activate the created virtual environment:
|
|
229
|
+
|
|
230
|
+
.. code-block:: bash
|
|
231
|
+
|
|
232
|
+
workon xmlsec
|
|
233
|
+
|
|
234
|
+
#. Install ``xmlsec`` in development mode with testing enabled.
|
|
235
|
+
This will download all dependencies required for running the unit tests.
|
|
236
|
+
|
|
237
|
+
.. code-block:: bash
|
|
238
|
+
|
|
239
|
+
pip install -r requirements-test.txt
|
|
240
|
+
pip install -e "."
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
Running the test suite
|
|
244
|
+
^^^^^^^^^^^^^^^^^^^^^^
|
|
245
|
+
|
|
246
|
+
#. `Set up your environment <#setting-up-your-environment>`_.
|
|
247
|
+
|
|
248
|
+
#. Run the unit tests.
|
|
249
|
+
|
|
250
|
+
.. code-block:: bash
|
|
251
|
+
|
|
252
|
+
pytest tests
|
|
253
|
+
|
|
254
|
+
#. Tests configuration
|
|
255
|
+
|
|
256
|
+
Env variable ``PYXMLSEC_TEST_ITERATIONS`` specifies number of
|
|
257
|
+
test iterations to detect memory leaks.
|
|
258
|
+
|
|
259
|
+
Reporting an issue
|
|
260
|
+
^^^^^^^^^^^^^^^^^^
|
|
261
|
+
|
|
262
|
+
Please attach the output of following information:
|
|
263
|
+
|
|
264
|
+
* version of ``xmlsec``
|
|
265
|
+
* version of ``libxmlsec1``
|
|
266
|
+
* version of ``libxml2``
|
|
267
|
+
* output from the command
|
|
268
|
+
|
|
269
|
+
.. code-block:: bash
|
|
270
|
+
|
|
271
|
+
pkg-config --cflags xmlsec1
|
|
272
|
+
|
|
273
|
+
License
|
|
274
|
+
*******
|
|
275
|
+
|
|
276
|
+
Unless otherwise noted, all files contained within this project are licensed under the MIT opensource license.
|
|
277
|
+
See the included ``LICENSE`` file or visit `opensource.org <http://opensource.org/licenses/MIT>`_ for more information.
|
|
@@ -3,18 +3,21 @@ python-xmlsec
|
|
|
3
3
|
|
|
4
4
|
.. image:: https://img.shields.io/pypi/v/xmlsec.svg?logo=python&logoColor=white
|
|
5
5
|
:target: https://pypi.python.org/pypi/xmlsec
|
|
6
|
-
.. image:: https://
|
|
7
|
-
:target: https://
|
|
6
|
+
.. image:: https://results.pre-commit.ci/badge/github/xmlsec/python-xmlsec/master.svg
|
|
7
|
+
:target: https://results.pre-commit.ci/latest/github/xmlsec/python-xmlsec/master
|
|
8
|
+
:alt: pre-commit.ci status
|
|
8
9
|
.. image:: https://img.shields.io/appveyor/ci/hoefling/xmlsec/master.svg?logo=appveyor&logoColor=white&label=AppVeyor
|
|
9
10
|
:target: https://ci.appveyor.com/project/hoefling/xmlsec
|
|
10
|
-
.. image:: https://github.com/mehcode/python-xmlsec/workflows/
|
|
11
|
-
:target: https://github.com/mehcode/python-xmlsec/actions
|
|
12
|
-
.. image:: https://github.com/mehcode/python-xmlsec/workflows/
|
|
13
|
-
:target: https://github.com/mehcode/python-xmlsec/actions
|
|
14
|
-
.. image:: https://github.com/mehcode/python-xmlsec/workflows/linuxbrew/badge.svg
|
|
15
|
-
:target: https://github.com/mehcode/python-xmlsec/actions
|
|
16
|
-
.. image:: https://
|
|
17
|
-
:target: https://
|
|
11
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml/badge.svg
|
|
12
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml
|
|
13
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml/badge.svg
|
|
14
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml
|
|
15
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml/badge.svg
|
|
16
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml
|
|
17
|
+
.. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml/badge.svg
|
|
18
|
+
:target: https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml
|
|
19
|
+
.. image:: https://codecov.io/gh/xmlsec/python-xmlsec/branch/master/graph/badge.svg
|
|
20
|
+
:target: https://codecov.io/gh/xmlsec/python-xmlsec
|
|
18
21
|
.. image:: https://img.shields.io/readthedocs/xmlsec/latest?logo=read-the-docs
|
|
19
22
|
:target: https://xmlsec.readthedocs.io/en/latest/?badge=latest
|
|
20
23
|
:alt: Documentation Status
|
|
@@ -34,7 +37,7 @@ Check the `examples <https://xmlsec.readthedocs.io/en/latest/examples.html>`_ se
|
|
|
34
37
|
Requirements
|
|
35
38
|
************
|
|
36
39
|
- ``libxml2 >= 2.9.1``
|
|
37
|
-
- ``libxmlsec1 >= 1.2.
|
|
40
|
+
- ``libxmlsec1 >= 1.2.33``
|
|
38
41
|
|
|
39
42
|
Install
|
|
40
43
|
*******
|
|
@@ -90,6 +93,12 @@ Mac
|
|
|
90
93
|
|
|
91
94
|
brew install libxml2 libxmlsec1 pkg-config
|
|
92
95
|
|
|
96
|
+
or
|
|
97
|
+
|
|
98
|
+
.. code-block:: bash
|
|
99
|
+
|
|
100
|
+
port install libxml2 xmlsec pkgconfig
|
|
101
|
+
|
|
93
102
|
|
|
94
103
|
Alpine
|
|
95
104
|
^^^^^^
|
|
@@ -133,7 +142,7 @@ Building from source
|
|
|
133
142
|
|
|
134
143
|
.. code-block:: bash
|
|
135
144
|
|
|
136
|
-
git clone https://github.com/
|
|
145
|
+
git clone https://github.com/xmlsec/python-xmlsec.git
|
|
137
146
|
|
|
138
147
|
#. Change into the ``python-xmlsec`` root directory.
|
|
139
148
|
|
|
@@ -45,3 +45,46 @@ known_third_party = ['lxml', 'pytest', '_pytest', 'hypothesis']
|
|
|
45
45
|
|
|
46
46
|
[build-system]
|
|
47
47
|
requires = ['setuptools>=42', 'wheel', 'setuptools_scm[toml]>=3.4', "pkgconfig>=1.5.1", "lxml>=3.8, !=4.7.0"]
|
|
48
|
+
|
|
49
|
+
[tool.cibuildwheel]
|
|
50
|
+
build-verbosity = 1
|
|
51
|
+
build-frontend = "build"
|
|
52
|
+
skip = [
|
|
53
|
+
"pp*",
|
|
54
|
+
"*-musllinux_i686",
|
|
55
|
+
# LXML doesn't publish wheels for these platforms, which makes it
|
|
56
|
+
# difficult for us to build wheels, so we exclude them.
|
|
57
|
+
"cp36-manylinux_aarch64",
|
|
58
|
+
"cp37-manylinux_aarch64",
|
|
59
|
+
"cp36-musllinux_aarch64",
|
|
60
|
+
"cp37-musllinux_aarch64",
|
|
61
|
+
"cp36-macosx*",
|
|
62
|
+
"cp37-macosx*",
|
|
63
|
+
"cp38-macosx*",
|
|
64
|
+
]
|
|
65
|
+
test-command = "pytest -v --color=yes {package}/tests"
|
|
66
|
+
before-test = "pip install -r requirements-test.txt"
|
|
67
|
+
test-skip = "*-macosx_arm64"
|
|
68
|
+
|
|
69
|
+
[tool.cibuildwheel.environment]
|
|
70
|
+
PYXMLSEC_STATIC_DEPS = "true"
|
|
71
|
+
|
|
72
|
+
[tool.cibuildwheel.linux]
|
|
73
|
+
archs = ["x86_64", "aarch64", "i686"]
|
|
74
|
+
environment-pass = [
|
|
75
|
+
"PYXMLSEC_LIBXML2_VERSION",
|
|
76
|
+
"PYXMLSEC_LIBXSLT_VERSION",
|
|
77
|
+
"PYXMLSEC_STATIC_DEPS",
|
|
78
|
+
"GH_TOKEN"
|
|
79
|
+
]
|
|
80
|
+
|
|
81
|
+
[tool.cibuildwheel.macos]
|
|
82
|
+
archs = ["x86_64", "arm64"]
|
|
83
|
+
before-all = "brew install perl"
|
|
84
|
+
|
|
85
|
+
[tool.cibuildwheel.windows]
|
|
86
|
+
archs = ["AMD64", "x86"]
|
|
87
|
+
|
|
88
|
+
[[tool.cibuildwheel.overrides]]
|
|
89
|
+
select = "*-manylinux*"
|
|
90
|
+
before-all = "yum install -y perl-core"
|
|
@@ -18,6 +18,9 @@ upload_dir = doc/build/html
|
|
|
18
18
|
[flake8]
|
|
19
19
|
per-file-ignores =
|
|
20
20
|
*.pyi: E301, E302, E305, E501, E701, F401, F822
|
|
21
|
+
doc/source/conf.py: D1
|
|
22
|
+
doc/source/examples/*.py: D1, E501
|
|
23
|
+
tests/*.py: D1
|
|
21
24
|
exclude = .venv*,.git,*_pb2.pyi,build,dist,libs,.eggs,.direnv*
|
|
22
25
|
max-line-length = 130
|
|
23
26
|
|