Giter VIP home page Giter VIP logo

myproject's Introduction

myproject: a demo python repository with GitHub actions for code quality

Live status:

Testing Codecov Linting FormattingOpen issues

Tooling

linting: pylint Formatter my badge


Python Continuous Integration with GitHub Actions demo

This minimal example is to show how to setup a project directory for a python project structuring:

  • all the code under the src directory, with each subdirectory being a package, and under it one or more module files, each containing one or more functions/classes
  • Code is evaluated with pylint (pylint src)
  • all the tests are under the tests directory to be picked up by pytest and each test imports the needed modules and functions.
  • pytest will also perform a coverage test to be sent to Codecov
  • the workflow automating all of this is in the .github/workflows directory and is triggered by a push to the master branch

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.