Build a Python app with PyInstaller

Ensure you are signed in to your GitHub account. If you don’t yet have a GitHub account, sign up for a free one on the GitHub website.

Fork the simple-python-pyinstaller-app on GitHub into your local GitHub account. If you need help with this process, refer to the Fork A Repo documentation on the GitHub website for more information.

Clone your forked simple-python-pyinstaller-app repository (on GitHub)locally to your machine. To begin this process, do either of the following (where <your-username> is the name of your user account on your operating system):

Obtain the latest Jenkins LTS instance, customized for this tutorial, by cloning the quickstart-tutorials repository.

After cloning, navigate to the quickstart-tutorials directory, and execute the command

docker compose --profile python up -d

Once the containers (one for the controller, one for the agent) are running successfully (you can verify this with docker compose ps), the controller can be accessed at http://localhost:8080.

In Jenkins, select New Item under Dashboard > at the top left.

Enter your new Pipeline project name in Enter an item name (e.g. simple-python-pyinstaller-app).

Scroll down if necessary and select Pipeline, then click OK at the end of the page.

(Optional) Enter a Pipeline Description.

Select Pipeline on the left pane.

Select Definition, and then choose the Pipeline script from SCM option. This option instructs Jenkins to obtain your Pipeline from the source control management (SCM), which is your forked Git repository.

Choose Git from the options in SCM.

Enter the URL of your repository in Repositories/Repository URL. This URL can be found when clicking on the green button Code in the main page of your GitHub repo.

Hit the Save button at the end of the page. You’re now ready to create a Jenkinsfile to check into your locally cloned Git repository.

Using your favorite text editor or IDE, create and save a new text file with the name Jenkinsfile at the root of your local simple-python-pyinstaller-app Git repository.

Copy the following Declarative Pipeline code and paste it into your empty Jenkinsfile:

pipeline {
    agent any (1)
    stages {
        stage('Build') { (2)
            steps {
                sh 'python -m py_compile sources/add2vals.py sources/calc.py' (3)
                stash(name: 'compiled-results', includes: 'sources/*.py*') (4)
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local simple-python-pyinstaller-app Git repository. E.g. Within the simple-python-pyinstaller-app directory, run the commands:
git add .
then
git commit -m "Add initial Jenkinsfile"
and in the end
git push

In Jenkins, select Build Now on the left pane.

After making a clone of your local simple-python-pyinstaller-app Git repository itself, Jenkins:

You should now see on the left a green check mark and #1, indicating that your first Pipeline has run successfully.

You should also see in the main part of the page a Stage View of your Pipeline, which shows the Build stage run, indicating that your first Pipeline has run successfully.

Go back to your text editor/IDE and ensure your Jenkinsfile is open.

Copy and paste the following Declarative Pipeline syntax immediately under the Build stage of your Jenkinsfile:

        stage('Test') {
            steps {
                sh 'py.test --junit-xml test-reports/results.xml sources/test_calc.py'
            }
            post {
                always {
                    junit 'test-reports/results.xml'
                }
            }
        }

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'python -m py_compile sources/add2vals.py sources/calc.py'
                stash(name: 'compiled-results', includes: 'sources/*.py*')
            }
        }
        stage('Test') { (1)
            steps {
                sh 'py.test --junit-xml test-reports/results.xml sources/test_calc.py' (2)
            }
            post {
                always {
                    junit 'test-reports/results.xml' (3)
                }
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local simple-python-pyinstaller-app Git repository. E.g. Within the simple-python-pyinstaller-app directory, run the commands:
git add .
then
git commit -m "Add 'Test' stage" and in the end
git push

In Jenkins, navigate back to the Dashboard if necessary, then simple-python-pyinstaller-app and launch another build thanks to Build Now.

After a while, you should see a new column labeled Test appear in the Stage View.

You can click on #2 or on the number representing your last build on the left, under Build History. You will then see the details of the build.

Go back to your text editor/IDE and ensure your Jenkinsfile is open.

Copy and paste the following Declarative Pipeline syntax immediately under the Test stage of your Jenkinsfile:

        stage('Deliver') {
            steps {
                sh "pyinstaller --onefile sources/add2vals.py"
            }
            post {
                success {
                    archiveArtifacts 'dist/add2vals'
                }
            }
        }

pipeline {
    agent any
    options {
        skipStagesAfterUnstable()
    }
    stages {
        stage('Build') {
            steps {
                sh 'python -m py_compile sources/add2vals.py sources/calc.py'
                stash(name: 'compiled-results', includes: 'sources/*.py*')
            }
        }
        stage('Test') {
            steps {
                sh 'py.test --junit-xml test-reports/results.xml sources/test_calc.py'
            }
            post {
                always {
                    junit 'test-reports/results.xml'
                }
            }
        }
        stage('Deliver') { (1)
            steps {
                sh "pyinstaller --onefile sources/add2vals.py" (2)
            }
            post {
                success {
                    archiveArtifacts 'dist/add2vals' (3)
                }
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local simple-python-pyinstaller-app Git repository. E.g. Within the simple-python-pyinstaller-app directory, run the commands:
git add .
then
git commit -m "Add 'Deliver' stage"
and in the end
git push

In Jenkins, sign in if necessary, and go back to the Dashboard and then simple-python-pyinstaller-app or go directly to simple-python-pyinstaller-app depending on where you’re starting from.

Select Build Now on the left. After a while, you should see a new column labeled Deliver appear in the Stage View.

You can click on #3 or on the number representing your last build, in the left pane under Build History to see the details of the build.

You can now click on simple-python-pyinstaller-app on the top left, and then on Stages at the left. It will list your previous Pipeline runs in reverse chronological order.

Access the Stage View interface (found after clicking on Dashboard > simple-python-pyinstaller-app or directly on simple-python-pyinstaller-app if it’s accessible). You should see a Last Successful Artifacts section on top of Stage View.

You should then see a add2vals link in the Last Successful Artifacts section.

Click the link to download the standalone executable file to your browser’s "Downloads" directory.

Back in your operating system’s terminal prompt, cd to your browser’s "Downloads" directory.

Make the add2vals file executable - i.e. chmod a+x add2vals

Run the command ./add2vals and follow the instructions provided by your app.