Skip to content

Commit 6fb3974

Browse files
committed
Add README.md file content
1 parent 0fdc855 commit 6fb3974

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
11
# simple-python-pyinstaller-app
2+
3+
This repository is for the
4+
[Build a Python app with PyInstaller](https://jenkins.io/doc/tutorials/build-a-python-app-with-pyinstaller/)
5+
tutorial in the [Jenkins User Documentation](https://jenkins.io/doc/).
6+
7+
The repository contains a simple Python application which is a command line tool "add2vals" that outputs the addition of two values. If at least one of the
8+
values is a string, "add2vals" treats both values as a string and instead
9+
concatenates the values. The "add2" function in the "calc" library (which
10+
"add2vals" imports) is accompanied by a set of unit tests. These are tested with pytest to check that this function works as expected and the results are saved
11+
to a JUnit XML report.
12+
13+
The delivery of the "add2vals" tool through PyInstaller converts this tool into
14+
a standalone executable file for Linux, which you can download through Jenkins
15+
and execute at the command line on Linux machines without Python.
16+
17+
The `jenkins` directory contains an example of the `Jenkinsfile` (i.e. Pipeline)
18+
you'll be creating yourself during the tutorial and the `scripts` subdirectory
19+
contains a shell script with commands that are executed when Jenkins processes
20+
the "Deliver" stage of your Pipeline.

0 commit comments

Comments
 (0)