CONTRIBUTING.md

Contributing to ASAB

This document outlines some of the conventions for contributing to ASAB code.

Coding conventions

ASAB is a Python project.

PEP8

We in TeskaLabs are following PEP8 Style Guide for Python Code. PEP8 is a document that provides guidelines and best practices on how to write Python code. The primary focus of PEP 8 is to improve the readability and consistency of Python code.

flake8

You can check if changes in your code are compliant with PEP8 by running following command

flake8 .

It is highly recommended to create a pre-commit hook (.git/hooks/pre-commit)

#!/bin/sh
echo "Running flake8 ..."
flake8 .

Hook must be executable (chmod u+x .git/hooks/pre-commit)

This hook is part of TravisCI

Imports

Imports shall be writen one-per-line style as per the example below

import os
import sys
import logging
...

Following additional rules apply for imports:

1. Use relative imports when you import locally from a package
2. Use absolute imports when you import from external package
3. Never use from ... import ... because it unnecessarily increases complexity for readers (unless you have very good reason for that). The only exception is __init__.py where it is used for importing symbols that you want to expose as a given module public API

Documenting functions, methods and classes

Functions, methods and classes should be documented using quotation marks, see the example below

def publish(self, event_name, *args, **kwargs):
	""" Notify subscribers of an event with arguments. """

	callback_set = self.subscribers.get(event_name)
	...

Publishing to pypi.org

1. Create a version tag (git tag -a v19.10)
2. Push a tag to GitHub (git push origin v19.10)
3. Make local build (python3 setup.py sdist bdist_wheel)
4. Publish a package to pypi.org (twine upload dist/*)