Pipenv pipeline

# Byte-compiled / optimized / DLL files

__pycache__/

*.py[cod]

*$py.class

# C extensions

*.so

# Distribution / packaging

.Python

build/

develop-eggs/

dist/

downloads/

eggs/

.eggs/

lib/

lib64/

parts/

sdist/

var/

wheels/

*.egg-info/

.installed.cfg

*.egg

MANIFEST

# PyInstaller

#  Usually these files are written by a python script from a template

#  before PyInstaller builds the exe, so as to inject date/other infos into it.

*.manifest

*.spec

# Installer logs

pip-log.txt

pip-delete-this-directory.txt

# Unit test / coverage reports

htmlcov/

.tox/

.coverage

.coverage.*

.cache

nosetests.xml

coverage.xml

*.cover

.hypothesis/

.pytest_cache/

# Translations

*.mo

*.pot

# Django stuff:

*.log

local_settings.py

db.sqlite3

# Flask stuff:

instance/

.webassets-cache

# Scrapy stuff:

.scrapy

# Sphinx documentation

docs/_build/

# PyBuilder

target/

# Jupyter Notebook

.ipynb_checkpoints

# pyenv

.python-version

# celery beat schedule file

celerybeat-schedule

# SageMath parsed files

*.sage.py

# Environments

.env

.venv

env/

venv/

ENV/

env.bak/

venv.bak/

# Spyder project settings

.spyderproject

.spyproject

# Rope project settings

.ropeproject

# mkdocs documentation

/site

# mypy

.mypy_cache/

# Idea specific

.idea/

# This file is a template, and might need editing before it works on your project.

# Official framework image. Look for the different tagged releases at:

# https://hub.docker.com/r/library/python

image: python:latest

# This folder is cached between builds

# http://docs.gitlab.com/ce/ci/yaml/README.html#cache

cache:

  paths:

  - ~/.cache/pip/

stages:

  - build

build:

  stage: build

  tags:

    - shared-fi

  before_script:

    - python -V                                   # Print out python version for debugging

    - pip install pipenv

  script:

    - pipenv install --dev

    - pipenv run coverage run -m pytest

[[source]]

url = "https://pypi.python.org/simple"

verify_ssl = true

name = "pypi"

[packages]

[dev-packages]

coverage = "*"

pytest = "*"

pytest-cov = "*"

[requires]

python_version = "3.6"

{

    "_meta": {

        "hash": {

            "sha256": "7f5b8ca3c9866199a2c8b60388851ec7dfb11d416b13fd29c0e4eefaf4096fbc"

        },

        "pipfile-spec": 6,

        "requires": {

            "python_version": "3.6"

        },

        "sources": [

            {

                "name": "pypi",

                "url": "https://pypi.python.org/simple",

                "verify_ssl": true

            }

        ]

    },

    "default": {},

    "develop": {

        "attrs": {

            "hashes": [

                "sha256:1c7960ccfd6a005cd9f7ba884e6316b5e430a3f1a6c37c5f87d8b43f83b54ec9",

                "sha256:a17a9573a6f475c99b551c0e0a812707ddda1ec9653bed04c13841404ed6f450"

            ],

            "version": "==17.4.0"

        },

        "coverage": {

            "hashes": [

                "sha256:03481e81d558d30d230bc12999e3edffe392d244349a90f4ef9b88425fac74ba",

                "sha256:0b136648de27201056c1869a6c0d4e23f464750fd9a9ba9750b8336a244429ed",

                "sha256:104ab3934abaf5be871a583541e8829d6c19ce7bde2923b2751e0d3ca44db60a",

                "sha256:15b111b6a0f46ee1a485414a52a7ad1d703bdf984e9ed3c288a4414d3871dcbd",

                "sha256:198626739a79b09fa0a2f06e083ffd12eb55449b5f8bfdbeed1df4910b2ca640",

                "sha256:1c383d2ef13ade2acc636556fd544dba6e14fa30755f26812f54300e401f98f2",

                "sha256:28b2191e7283f4f3568962e373b47ef7f0392993bb6660d079c62bd50fe9d162",

                "sha256:2eb564bbf7816a9d68dd3369a510be3327f1c618d2357fa6b1216994c2e3d508",

                "sha256:337ded681dd2ef9ca04ef5d93cfc87e52e09db2594c296b4a0a3662cb1b41249",

                "sha256:3a2184c6d797a125dca8367878d3b9a178b6fdd05fdc2d35d758c3006a1cd694",

                "sha256:3c79a6f7b95751cdebcd9037e4d06f8d5a9b60e4ed0cd231342aa8ad7124882a",

                "sha256:3d72c20bd105022d29b14a7d628462ebdc61de2f303322c0212a054352f3b287",

                "sha256:3eb42bf89a6be7deb64116dd1cc4b08171734d721e7a7e57ad64cc4ef29ed2f1",

                "sha256:4635a184d0bbe537aa185a34193898eee409332a8ccb27eea36f262566585000",

                "sha256:56e448f051a201c5ebbaa86a5efd0ca90d327204d8b059ab25ad0f35fbfd79f1",

                "sha256:5a13ea7911ff5e1796b6d5e4fbbf6952381a611209b736d48e675c2756f3f74e",

                "sha256:69bf008a06b76619d3c3f3b1983f5145c75a305a0fea513aca094cae5c40a8f5",

                "sha256:6bc583dc18d5979dc0f6cec26a8603129de0304d5ae1f17e57a12834e7235062",

                "sha256:701cd6093d63e6b8ad7009d8a92425428bc4d6e7ab8d75efbb665c806c1d79ba",

                "sha256:7608a3dd5d73cb06c531b8925e0ef8d3de31fed2544a7de6c63960a1e73ea4bc",

                "sha256:76ecd006d1d8f739430ec50cc872889af1f9c1b6b8f48e29941814b09b0fd3cc",

                "sha256:7aa36d2b844a3e4a4b356708d79fd2c260281a7390d678a10b91ca595ddc9e99",

                "sha256:7d3f553904b0c5c016d1dad058a7554c7ac4c91a789fca496e7d8347ad040653",

                "sha256:7e1fe19bd6dce69d9fd159d8e4a80a8f52101380d5d3a4d374b6d3eae0e5de9c",

                "sha256:8c3cb8c35ec4d9506979b4cf90ee9918bc2e49f84189d9bf5c36c0c1119c6558",

                "sha256:9d6dd10d49e01571bf6e147d3b505141ffc093a06756c60b053a859cb2128b1f",

                "sha256:9e112fcbe0148a6fa4f0a02e8d58e94470fc6cb82a5481618fea901699bf34c4",

                "sha256:ac4fef68da01116a5c117eba4dd46f2e06847a497de5ed1d64bb99a5fda1ef91",

                "sha256:b8815995e050764c8610dbc82641807d196927c3dbed207f0a079833ffcf588d",

                "sha256:be6cfcd8053d13f5f5eeb284aa8a814220c3da1b0078fa859011c7fffd86dab9",

                "sha256:c1bb572fab8208c400adaf06a8133ac0712179a334c09224fb11393e920abcdd",

                "sha256:de4418dadaa1c01d497e539210cb6baa015965526ff5afc078c57ca69160108d",

                "sha256:e05cb4d9aad6233d67e0541caa7e511fa4047ed7750ec2510d466e806e0255d6",

                "sha256:e4d96c07229f58cb686120f168276e434660e4358cc9cf3b0464210b04913e77",

                "sha256:f3f501f345f24383c0000395b26b726e46758b71393267aeae0bd36f8b3ade80",

                "sha256:f8a923a85cb099422ad5a2e345fe877bbc89a8a8b23235824a93488150e45f6e"

            ],

            "index": "pypi",

            "version": "==4.5.1"

        },

        "more-itertools": {

            "hashes": [

                "sha256:0dd8f72eeab0d2c3bd489025bb2f6a1b8342f9b198f6fc37b52d15cfa4531fea",

                "sha256:11a625025954c20145b37ff6309cd54e39ca94f72f6bb9576d1195db6fa2442e",

                "sha256:c9ce7eccdcb901a2c75d326ea134e0886abfbea5f93e91cc95de9507c0816c44"

            ],

            "version": "==4.1.0"

        },

        "pluggy": {

            "hashes": [

                "sha256:7f8ae7f5bdf75671a718d2daf0a64b7885f74510bcd98b1a0bb420eb9a9d0cff",

                "sha256:d345c8fe681115900d6da8d048ba67c25df42973bda370783cd58826442dcd7c",

                "sha256:e160a7fcf25762bb60efc7e171d4497ff1d8d2d75a3d0df7a21b76821ecbf5c5"

            ],

            "version": "==0.6.0"

        },

        "py": {

            "hashes": [

                "sha256:29c9fab495d7528e80ba1e343b958684f4ace687327e6f789a94bf3d1915f881",

                "sha256:983f77f3331356039fdd792e9220b7b8ee1aa6bd2b25f567a963ff1de5a64f6a"

            ],

            "version": "==1.5.3"

        },

        "pytest": {

            "hashes": [

                "sha256:6266f87ab64692112e5477eba395cfedda53b1933ccd29478e671e73b420c19c",

                "sha256:fae491d1874f199537fd5872b5e1f0e74a009b979df9d53d1553fd03da1703e1"

            ],

            "index": "pypi",

            "version": "==3.5.0"

        },

        "pytest-cov": {

            "hashes": [

                "sha256:03aa752cf11db41d281ea1d807d954c4eda35cfa1b21d6971966cc041bbf6e2d",

                "sha256:890fe5565400902b0c78b5357004aab1c814115894f4f21370e2433256a3eeec"

            ],

            "index": "pypi",

            "version": "==2.5.1"

        },

        "six": {

            "hashes": [

                "sha256:70e8a77beed4562e7f14fe23a786b54f6296e34344c23bc42f07b15018ff98e9",

                "sha256:832dc0e10feb1aa2c68dcc57dbb658f1c7e65b9b61af69048abc87a2db00a0eb"

            ],

            "version": "==1.11.0"

        }

    }

}

= GitLab CI Python with Pipenv Example

Please refer to the link:https://docs.gitlab.com/ce/ci/yaml/README.html[official documentation]

to view all configuration options available.

This project contains a simple Python fibonacci implementation.

Project is build using link:https://github.com/pypa/pipenv[Pipenv].

Tests are written in the link:https://pytest.org/[pytest].

Let's break down the contents of `.gitlab-ci.yaml`:

[source, yaml]

----

image: python:latest

----

The first line declares that the runner should use official link:https://hub.docker.com/_/python/[python] image.

[source, yaml]

----

stages:

  - build

----

The whole pipeline has only a single stage called `build`.

[source, yaml]

----

build:

  stage: build

----

The second line seems superfluous, but in general the stages do not need

to be called `build` or `test` and there can be more than one.

The `stage: build` declaration merely informs the runner that this stage

is actually part of the build *phase*.

[source, yaml]

----

  tags:

    - shared-fi

----

`gitlab-ci.fi.muni.cz` will only run jobs that have tag `shared-fi`.

[source, yaml]

----

  before_script:

    - python -V                                   # Print out python version for debugging

    - pip install pipenv

----

`before_script` is used to define the command that should be run before all jobs, 

including deploy jobs, but after the restoration of artifacts. This can be an array or a multi-line string.

You need to install pipenv because it is not bundled by default in the container.

[source, yaml]

----

  script:

    - pipenv install --dev

    - pipenv run coverage run -m pytest

----

Finally, the `script` section contains a list of commands that shall be

performed inside the repository once the runner starts.

These *should* be executed inside a single shell instance so that

`cd` and similar commands should work as expected, but unfortunately

this is not specified in the official documentation.