Skip to content

Commit 7f67fe1

Browse files
committed
Merge branch 'main' of github.com:clauspruefer/python-xml-microparser
2 parents ddc45c3 + d8d855f commit 7f67fe1

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,18 @@ Documentation including examples can be found at either [./doc](./doc) or [https
88

99
## 2. Installation
1010

11-
Most Linux Distributions come with already Python3 met dependencies (see **2.1**).
11+
```bash
12+
# pip install xmlmicroparser
13+
```
1214

13-
Just download the current Relase Zip / Tarball @ [Release 0.54Beta](https://github.com/clauspruefer/python-xml-microparser/releases/tag/0.54beta) and continue with section **2.2**.
15+
Or download the current Relase Zip / Tarball @ [Release 0.54Beta](https://github.com/clauspruefer/python-xml-microparser/releases/tag/0.54beta) and continue with section **2.2**.
1416

1517
## 2.1. Dependencies
1618

17-
You need the `pip3` Python3 Package Installer, Python3 Setuptools `python3-setuptools` and the downloaded XML-Microparser
18-
Package found under Releases.
19+
You need Python3 setuptools to build the package manually. Pytest / PEP-8 packages are required to run tests.
1920

2021
```bash
21-
# apt-get install python3-setuptools python3-pip
22+
# apt-get install python3-setuptools python3-pip python3-pytest python3-pytest-pep8
2223
```
2324

2425
>[!IMPORTANT]
@@ -43,13 +44,14 @@ Do this for a pip system where `--break-system-packages` is needed.
4344

4445
## 3. Build Manually
4546

46-
First update local git repository. The `setup.py` metadata used for pip resides in `/`.
47+
Clone git repository and change dir.
4748

4849
```bash
49-
# cd repodir
5050
# git clone https://github.com/clauspruefer/python-xml-microparser.git
51+
# cd python-xml-microparser
52+
5153
```
52-
## 2.3. Build As Non-Root-User
54+
## 3.1. Build As Non-Root-User
5355

5456
Build python-package with setup-tools (as non root user). This will generate the installabe tarball
5557
into `./dist/xmlmicroparser-0.54b0.tar.gz`.
@@ -58,7 +60,13 @@ into `./dist/xmlmicroparser-0.54b0.tar.gz`.
5860
# python3 setup.py sdist
5961
```
6062

61-
## 4. Boost Python
63+
## 4. Run Tests / Pytest
64+
65+
```bash
66+
# pytest
67+
```
68+
69+
## 5. Boost Python
6270

6371
Using the XML-Microparser Module with Boost Python C++ https://www.boost.org/doc/libs/1_86_0/libs/python/doc/html/index.html
6472
makes XML configuration handling in C++ projects easy.

0 commit comments

Comments
 (0)