Code Monkey home page Code Monkey logo

loadout's Introduction

Loadout

linting: pylint Imports: isort Checked with mypy Code style: black MIT license Tests: pytest Conventional Commits: 1.0.0 security: bandit pre-commit GitHub release Github tag

Loadout makes developer machine setup painless & deterministic.

Getting Started

  1. Make sure you have the python version specified in .python-version installed via pyenv.
  2. Run make init-workspace
    • To learn more about how to interact with the workspace run make for the help text

Tooling

  • Loadout uses Pyenv for Python version management. The Pyenv reads the version to use from the .python-version file in the root of the repo (further reading: Pyenv - Understanding Python Version Selection).
  • Package management is handled by Poetry. Poetry uses the python provided by Pyenv to create virtual environments.
  • We have a variety of tools to cover code quality
    • Types: Typing is handled by Mypy.
    • Linting: We use both Pylint & Flake8. It was tough to find guidance on which one is the "right" linter, but some folks are using both. This may prove to be too restrictive or result in conflicts & need to be revisit. But for now that's the direction.
    • Import sorting: Isort manages our imports.
    • Formatting: You can format your code however you want "as long as it's Black
    • Security Analysis: Bandit performs static security analysis.
  • We run tests using pyTest. Coverage is generated by pytest-cov
  • debugpy allows debugging through VS Code.
  • Git hooks are run by pre-commit.
  • We use Commitizen to guide us as we write meaningful, expressive commit messages.
  • Our git hooks are managed by pre-commit.

loadout's People

Contributors

kevinmccartney 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.