11# python-xmlsec
22
33[ ![ image] ( https://img.shields.io/pypi/v/xmlsec.svg?logo=python&logoColor=white )] ( https://pypi.python.org/pypi/xmlsec )
4-
54[ ![ pre-commit.ci status] ( https://results.pre-commit.ci/badge/github/xmlsec/python-xmlsec/master.svg )] ( https://results.pre-commit.ci/latest/github/xmlsec/python-xmlsec/master )
6-
7- [ ![ image] ( https://img.shields.io/appveyor/ci/hoefling/xmlsec/master.svg?logo=appveyor&logoColor=white&label=AppVeyor )] ( https://ci.appveyor.com/project/hoefling/xmlsec )
8-
9- [ ![ image] ( https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml/badge.svg )] ( https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml )
10-
11- [ ![ image] ( https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml/badge.svg )] ( https://github.com/mehcode/python-xmlsec/actions/workflows/macosx.yml )
12-
13- [ ![ image] ( https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml/badge.svg )] ( https://github.com/mehcode/python-xmlsec/actions/workflows/linuxbrew.yml )
14-
15- [ ![ image] ( https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml/badge.svg )] ( https://github.com/mehcode/python-xmlsec/actions/workflows/opensuse-tumbleweed.yml )
16-
5+ [ ![ image] ( https://github.com/xmlsec/python-xmlsec/actions/workflows/manylinux.yml/badge.svg )] ( https://github.com/xmlsec/python-xmlsec/actions/workflows/manylinux.yml )
6+ [ ![ image] ( https://github.com/xmlsec/python-xmlsec/actions/workflows/macosx.yml/badge.svg )] ( https://github.com/xmlsec/python-xmlsec/actions/workflows/macosx.yml )
7+ [ ![ image] ( https://github.com/xmlsec/python-xmlsec/actions/workflows/linuxbrew.yml/badge.svg )] ( https://github.com/xmlsec/python-xmlsec/actions/workflows/linuxbrew.yml )
178[ ![ image] ( https://codecov.io/gh/xmlsec/python-xmlsec/branch/master/graph/badge.svg )] ( https://codecov.io/gh/xmlsec/python-xmlsec )
18-
199[ ![ Documentation Status] ( https://img.shields.io/readthedocs/xmlsec/latest?logo=read-the-docs )] ( https://xmlsec.readthedocs.io/en/latest/?badge=latest )
2010
2111Python bindings for the [ XML Security
@@ -35,8 +25,8 @@ verifying using the library.
3525
3626## Requirements
3727
38- - ` libxml2 >= 2.9.1 `
39- - ` libxmlsec1 >= 1.2.33 `
28+ - ` libxml2 >= 2.9.1 `
29+ - ` libxmlsec1 >= 1.2.33 `
4030
4131## Install
4232
@@ -109,99 +99,96 @@ Starting with 1.3.7, prebuilt wheels are available for Windows, so
10999running ` pip install xmlsec ` should suffice. If you want to build from
110100source:
111101
112- 1 . Configure build environment, see
113- [ wiki.python.org] ( https://wiki.python.org/moin/WindowsCompilers ) for
114- more details.
102+ 1 . Configure build environment, see
103+ [ wiki.python.org] ( https://wiki.python.org/moin/WindowsCompilers ) for
104+ more details.
115105
116- 2 . Install from source dist:
106+ 2 . Install from source dist:
117107
118108 ``` bash
119109 pip install xmlsec --no-binary=xmlsec
120110 ```
121111
122112# # Building from source
123113
124- 1. Clone the ` xmlsec` source code repository to your local computer.
114+ 1. Clone the ` xmlsec` source code repository to your local computer.
125115
126116 ` ` ` bash
127117 git clone https://github.com/xmlsec/python-xmlsec.git
128118 ` ` `
129119
130- 2. Change into the ` python-xmlsec` root directory.
120+ 2. Change into the ` python-xmlsec` root directory.
131121
132122 ` ` ` bash
133123 cd /path/to/xmlsec
134124 ` ` `
135125
136- 3. Install the project and all its dependencies using ` pip` .
126+ 3. Install the project and all its dependencies using ` pip` .
137127
138- ` ` ` bash
139- pip install .
140- ` ` `
128+ ` ` ` bash
129+ pip install .
130+ ` ` `
141131
142132# # Contributing
143133
144134# ## Setting up your environment
145135
146- 1. Follow steps 1 and 2 of the [manual installation
147- instructions](# building-from-source).
136+ 1. Follow steps 1 and 2 of the [manual installation
137+ instructions](# building-from-source).
148138
149- 2. Initialize a virtual environment to develop in. This is done so as
150- to ensure every contributor is working with close-to-identicial
151- versions of packages.
139+ 2. Initialize a virtual environment to develop in. This is done so as
140+ to ensure every contributor is working with close-to-identicial
141+ versions of packages.
152142
153- ` ` ` bash
154- mkvirtualenv xmlsec
155- ` ` `
143+ ` ` ` bash
144+ mkvirtualenv xmlsec
145+ ` ` `
156146
157- The ` mkvirtualenv` command is available from ` virtualenvwrapper`
158- package which can be installed by following
159- [link](http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation).
147+ The ` mkvirtualenv` command is available from ` virtualenvwrapper`
148+ package which can be installed by following
149+ [link](http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation).
160150
161- 3. Activate the created virtual environment:
151+ 3. Activate the created virtual environment:
162152
163- ` ` ` bash
164- workon xmlsec
165- ` ` `
153+ ` ` ` bash
154+ workon xmlsec
155+ ` ` `
166156
167- 4. Install ` xmlsec` in development mode with testing enabled. This will
168- download all dependencies required for running the unit tests.
157+ 4. Install ` xmlsec` in development mode with testing enabled. This will
158+ download all dependencies required for running the unit tests.
169159
170- ` ` ` bash
171- pip install -r requirements-test.txt
172- pip install -e " ."
173- ` ` `
160+ ` ` ` bash
161+ pip install -r requirements-test.txt
162+ pip install -e " ."
163+ ` ` `
174164
175165# ## Running the test suite
176166
177- 1. [Set up your environment](# setting-up-your-environment).
167+ 1. [Set up your environment](# setting-up-your-environment).
178168
179- 2. Run the unit tests.
169+ 2. Run the unit tests.
180170
181- ` ` ` bash
182- pytest tests
183- ` ` `
171+ ` ` ` bash
172+ pytest tests
173+ ` ` `
184174
185- 3. Tests configuration
175+ 3. Tests configuration
186176
187- Env variable ` PYXMLSEC_TEST_ITERATIONS` specifies number of test
188- iterations to detect memory leaks.
177+ Env variable ` PYXMLSEC_TEST_ITERATIONS` specifies number of test
178+ iterations to detect memory leaks.
189179
190180# ## Reporting an issue
191181
192182Please attach the output of following information:
193183
194- - version of ` xmlsec`
184+ - version of ` xmlsec`
185+ - version of ` libxmlsec1`
186+ - version of ` libxml2`
187+ - output from the command
195188
196- - version of ` libxmlsec1`
197-
198- - version of ` libxml2`
199-
200- - output from the command
201-
202- ` ` ` bash
203- pkg-config --cflags xmlsec1
204- ` ` `
189+ ` ` ` bash
190+ pkg-config --cflags xmlsec1
191+ ` ` `
205192
206193# # License
207194
0 commit comments