Giter Club home page Giter Club logo

python-pipeline's Introduction

Python Pipeline ๐Ÿ

Simple Docker pipeline to test your python code.

Features

In this repo i've add a very basic python project with only four elements: a requirements file, a Dockerfile, a pytest.ini file and a simple python test that always pass.

You can put several stages to your pipeline, but the most common stages are: Build, Test, Lint, Report, Tag.

  1. Build: Downloads and build dependencies.
  2. Test: Executes all tests found.
  3. Lint: Checks code style and bad code practicies.
  4. Report: Formats and exports the results to archiving.
  5. Tag: Adds a unique identifier to the version making it ready to release.

Installation

  1. Clone or download this repository.

  2. Move your code to this new structure or vice versa.

  3. Make sure the Dockerfile is on project root folder.

  4. Update the requiments with your dependencies or create your list of requirements. See the dependencies tutorial to more details.

  5. Make sure the name patterns on pytest.ini

  6. Make sure you have at least one passing test (there's one in test-pass.py)

  7. In Dockerfile rename the src folder following your project organizaziton.

Usage

Execute the docker build command

docker build -t your-docker-user/projetc-name:tag .

If every step works correctly the command docker images is going to list your newly created image.

If something goes wrong youll be promptly warned.

License

License: GPL v3

python-pipeline's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar edumco avatar

Watchers

 avatar  avatar

Forkers

diegosoarestech

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.