Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/python-formate/formate
Python formatting mate.
https://github.com/python-formate/formate
formatting linting python
Last synced: 26 days ago
JSON representation
Python formatting mate.
- Host: GitHub
- URL: https://github.com/python-formate/formate
- Owner: python-formate
- License: mit
- Created: 2021-01-25T22:05:43.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-11T10:32:14.000Z (over 1 year ago)
- Last Synced: 2023-09-23T02:08:04.202Z (over 1 year ago)
- Topics: formatting, linting, python
- Language: Python
- Homepage: https://formate.readthedocs.io/en/latest
- Size: 434 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
- awesome-python-code-formatters - formate
README
########
formate
########.. start short_desc
**Python formatting mate.**
.. end short_desc
``formate`` runs a series of user-selected hooks which reformat Python source files.
This can include `changing quote characters`_, `rewriting imports`_, and calling tools such as isort_ and yapf_.See `the documentation`_ for more information.
.. _changing quote characters: https://formate.readthedocs.io/en/latest/hooks.html#dynamic-quotes
.. _rewriting imports: https://formate.readthedocs.io/en/latest/hooks.html#collections-import-rewrite
.. _isort: https://pycqa.github.io/isort/
.. _yapf: https://github.com/google/yapf
.. _the documentation: https://formate.readthedocs.io/en/latest/.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|.. |docs| image:: https://img.shields.io/readthedocs/formate/latest?logo=read-the-docs
:target: https://formate.readthedocs.io/en/latest
:alt: Documentation Build Status.. |docs_check| image:: https://github.com/python-formate/formate/workflows/Docs%20Check/badge.svg
:target: https://github.com/python-formate/formate/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status.. |actions_linux| image:: https://github.com/python-formate/formate/workflows/Linux/badge.svg
:target: https://github.com/python-formate/formate/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status.. |actions_windows| image:: https://github.com/python-formate/formate/workflows/Windows/badge.svg
:target: https://github.com/python-formate/formate/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status.. |actions_macos| image:: https://github.com/python-formate/formate/workflows/macOS/badge.svg
:target: https://github.com/python-formate/formate/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status.. |actions_flake8| image:: https://github.com/python-formate/formate/workflows/Flake8/badge.svg
:target: https://github.com/python-formate/formate/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status.. |actions_mypy| image:: https://github.com/python-formate/formate/workflows/mypy/badge.svg
:target: https://github.com/python-formate/formate/actions?query=workflow%3A%22mypy%22
:alt: mypy status.. |requires| image:: https://dependency-dash.repo-helper.uk/github/python-formate/formate/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/python-formate/formate/
:alt: Requirements Status.. |coveralls| image:: https://img.shields.io/coveralls/github/python-formate/formate/master?logo=coveralls
:target: https://coveralls.io/github/python-formate/formate?branch=master
:alt: Coverage.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/python-formate/formate?logo=codefactor
:target: https://www.codefactor.io/repository/github/python-formate/formate
:alt: CodeFactor Grade.. |pypi-version| image:: https://img.shields.io/pypi/v/formate
:target: https://pypi.org/project/formate/
:alt: PyPI - Package Version.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/formate?logo=python&logoColor=white
:target: https://pypi.org/project/formate/
:alt: PyPI - Supported Python Versions.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/formate
:target: https://pypi.org/project/formate/
:alt: PyPI - Supported Implementations.. |wheel| image:: https://img.shields.io/pypi/wheel/formate
:target: https://pypi.org/project/formate/
:alt: PyPI - Wheel.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/formate?logo=anaconda
:target: https://anaconda.org/domdfcoding/formate
:alt: Conda - Package Version.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/formate?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/formate
:alt: Conda - Platform.. |license| image:: https://img.shields.io/github/license/python-formate/formate
:target: https://github.com/python-formate/formate/blob/master/LICENSE
:alt: License.. |language| image:: https://img.shields.io/github/languages/top/python-formate/formate
:alt: GitHub top language.. |commits-since| image:: https://img.shields.io/github/commits-since/python-formate/formate/v0.7.0
:target: https://github.com/python-formate/formate/pulse
:alt: GitHub commits since tagged version.. |commits-latest| image:: https://img.shields.io/github/last-commit/python-formate/formate
:target: https://github.com/python-formate/formate/commit/master
:alt: GitHub last commit.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/formate
:target: https://pypi.org/project/formate/
:alt: PyPI - Downloads.. end shields
Installation
--------------.. start installation
``formate`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install formate
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding* Then install
.. code-block:: bash
$ conda install formate
.. end installation