Metadata-Version: 2.1
Name: flake8-numbers
Version: 0.1.0
Summary: Flake8 Numbers Plugin
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
License: MIT
Project-URL: Changelog, https://github.com/frequenz-floss/flake8-numbers/releases
Project-URL: Issues, https://github.com/frequenz-floss/flake8-numbers/issues
Project-URL: Repository, https://github.com/frequenz-floss/flake8-numbers
Project-URL: Support, https://github.com/frequenz-floss/flake8-numbers/discussions/categories/support
Keywords: frequenz,python,lib,library,flake8_numbers,flake8,numbers,plugin
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: <4,>=3.11
Description-Content-Type: text/markdown
Provides-Extra: dev-flake8
Provides-Extra: dev-formatting
Provides-Extra: dev-mkdocs
Provides-Extra: dev-mypy
Provides-Extra: dev-noxfile
Provides-Extra: dev-pylint
Provides-Extra: dev-pytest
Provides-Extra: dev
License-File: LICENSE

# Flake8 Numbers Plugin

[![Build Status](https://github.com/frequenz-floss/flake8-numbers/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/flake8-numbers/actions/workflows/ci.yaml)
[![PyPI Package](https://img.shields.io/pypi/v/flake8-numbers)](https://pypi.org/project/flake8-numbers/)
[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/flake8-numbers/)

## Introduction

Flake8 Numbers Plugin

This plugin ensures that large numbers of all bases are using digit seperators for improved readability.

Some examples of well written numeric literals are:

```python
good_float   = 123_456_789.123_456_789
good_hex     = 0xA_DEAD_BEEF
good_decimal = 10_000_000
good_binary  = 0b1010_1010_1010
```

## Contributing

If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).
