Git Product home page Git Product logo

spark's Introduction

Spark

Build Coverage

Spark is a Python3 project pattern. It can be considered as a starting point for new Python3 applications using state-of-the-art technologies.

Features

  • Runnable as python virtual env and system wide
  • Unit-Tests (using tox, unittest)
  • Code coverage
  • CI-Support (Travis CI)
  • Debian packaging
  • Documentation generation
  • Git version awareness

Setup

Requirements

The only requirement for building the application is

  • python3.5
  • curl

Everything else is being downloaded automatic to a Python virtual environment.

Clone the sources

$ git clone https://github.com/masmu/spark.git
$ cd spark/

Build the application

$ make

Usage

Run the application

$ bin/spark

Run unit tests

$ make test

The test suite includes unit tests, linting, code coverage and manifest checking. You can find a HTML coverage report in the htmlcov/ folder.

Generate documentation

$ make docs

You can find the generated documentation in the docs/ folder of the source directory.

Build Debian packages

You need to setup the debian packaging environment before: On Ubuntu you can do this via:

$ sudo apt-get install pbuilder debootstrap devscripts lintian
$ sudo pbuilder create --debootstrapopts --variant=buildd

After that you should enable Universe support for pbuilder. For that add the following to your ~/.pbuilderrc

COMPONENTS="main restricted universe multiverse"

if [ "$DIST" == "squeeze" ]; then
    echo "Using a Debian pbuilder environment because DIST is $DIST"
    COMPONENTS="main contrib non-free"
fi

After adding those new sources run the following command to update pbuilder:

$ sudo pbuilder update --override-config

Now you should be able to create Debian packages via:

$ make deb

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.