Giter Club home page Giter Club logo

pyfai's Introduction

FAI Python Lib

Documentation Status

Library for FAI customization scripts

This Python lib eases the implementation of FAI customization scripts with a high level of abstraction and resonable error handling. It is meant to be import'ed in scripts run by fai-do-scripts(1) during an FAI installation or softupdate.

Documentation

The compiled documentation can be found on Read the Docs.

The documentation is based on Sphinx and can be built using make: make doc. Documentation sources are in the docs/ directory.

Tests

Tests reside in the tests/ directory and are based on pytest and can be run easily using make: make test

Formatting

The code is formatted with yapf. Simply use make to format the code in place: make format.

Code Check

With the make command make check the code base is tested (including documentation), analyzed with pylint, and the code formatting verified.

Pylint messages should be fixed or directly suppressed in the code if necessary. A suppression should have a comment explaining briefly why the construct is ok (e.g., "false positive").

Consider using make check as pre-commit hook.

Makefile

A Makefile is provided to ease testing and building Python packages. Run make help for usage hints.

Packaging and Releasing

This lib uses PEP 517/PEP 518-compatible packaging based on setuptools. All project settings should normally go into setup.cfg, while setup.py is mainly provided for compatibility. The build system configuration resides in pyproject.toml.

Each released version is tagged with a tag of the form release/x.y.z with x, y, and z being major, minor, and patch version, respectively, as defined by Semantic Versioning.

pyfai's People

Contributors

st31ny avatar

Stargazers

 avatar

Watchers

 avatar  avatar

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.