Development

Pull Request

PR’s are Welcome!

Metric Dashboard

test codecov pre-commit.ci status Documentation Status made-with-sphinx-doc Scrutinizer Code Quality CodeQL Requirements Status cli-calc Dependencies Python Version PyPI - Implementation Python Lang Languages wemake-python-styleguide SLOC SLOC Tests SLOC Dev code size Maintenance MIT pypi status github stars pypi github release pypi wheel pypi uptime (last 30 days) pypi downloads last commit GitHub commits since latest release (by SemVer) github commits since github commits rate github issues next milestone github bugs open github bugs closed github issues open github now github issues closed github help open Pull Requests open Pull Requests merged Relative date gh uptime (last 30 days) github downloads

SNYK mostly not working :-(

Known Vulnerabilities Snyk Vulnerabilities

Note on Shields

Dependencies
  1. flake8-commas, one of the development plugins of the wemake-python-styleguide is marked as No Maintenance Intended. See this Issue. Most probable wemake will replace this dependency with a fork.

  2. python 3.7 is deprecated. However some dev tools are still dependant.

Snyk Vulnerabilities Requirements Status
  • Issues Too many dependencies. We try to update as good as possible.

Features

Tools

Python Packages

Style and type annotations

  • pylint vim linter

  • isort sort imports

  • black opinionated code formatter

    • wemake strictest and most opinionated Python linter

  • mypy static type checker

  • flake8 Style Guide Enforcement

    • nitpick enforce the same settings across configuration files

Testing

Continuous Testing & Integration (CT & CI)

Integration as in: Deployment and Integration testing.

Semantic Commits

Commit tools

Build and publish to pypi

Following Semantic Versioning

Development Environment

  • poetry python packaging and dependency management

  • cookiecutter creates projects from project templates

  • venv creates projects from project templates

Version and Issue Management

  • git distributed version control system

  • github online collaborative version control

  • tickgit Not used, but collects TODO from source code

IDE

If needed

  • jupyter for rapid prototyping only

Shell

Hardware

Server

Documentation

Metric

Jason Query for Makefile and Shields

Teaching Python Development

cli-calc Examples

make

github actions

Doc

NvK Tools

Work-Arounds

In order to supress the setup.py warning:

vi /YOUR-PATH/virtualenvs/cli-calc-kPZNduUb-py3.9/lib/python3.9/site-packages/setuptools/command/install.py +34
"""
NvK 2022-07: comment out
warnings.warn(
    "setup.py install is deprecated. "
    "Use build and pip and other standards-based tools.",
    setuptools.SetuptoolsDeprecationWarning,
)
"""