| Name | blue JSON |
| Version |
0.9.1
JSON |
| download |
| home_page | https://blue.readthedocs.io/ |
| Summary | Blue -- Some folks like black but I prefer blue. |
| upload_time | 2022-08-01 16:38:53 |
| maintainer | |
| docs_url | None |
| author | Grant Jenks |
| requires_python | |
| license | Apache 2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
====
Blue
====
Some folks like `black <https://black.readthedocs.io/en/stable/>`_ but I
prefer `blue <https://blue.readthedocs.io/en/latest/>`_.
What is blue?
=============
``blue`` is a somewhat less uncompromising code formatter than ``black``, the
OG of Python formatters. We love the idea of automatically formatting Python
code, for the same reasons that inspired ``black``, however we take issue with
some of the decisions ``black`` makes. Kudos to ``black`` for pioneering code
formatting for Python, and for its excellent implementation.
Where the ``blue`` maintainers disagree with the stylistic (and
unconfigurable) choices made by ``black``, we monkeypatch to change these
decisions to our own liking. We intend for these differences to be minimal;
even in cases where we'd prefer something different, there's a lot we can live
with for the sake of consistency.
We'd prefer not to fork or monkeypatch. Instead, our hope is that eventually
we'll be able to work with the ``black`` maintainers to add just a little bit
of configuration and merge back into the ``black`` project. We'd be ecstatic
if ``blue`` eventually were retired. Until then, we'll maintain our small set
of hacks on top of ``black`` and carefully consider what other deviations are
needed to assuage our sensitive, but experienced, eye.
How do I use blue?
==================
Exactly the same as you would use ``black``. Invoke and configure ``blue`` as
you would ``black`` -- just replace the ``black`` command with ``blue``, sit
back, and enjoy even betterly formatted Python code! You can refer to
`black's <https://black.readthedocs.io/en/stable/>`_ documentation for
anything not listed here.
Try it out now using `iblueit.dev <https://iblueit.dev/>`_.
So what's different?
====================
Here is a brief list of differences between ``blue`` and ``black``:
* ``blue`` defaults to single-quoted strings. This is probably the most
painful ``black`` choice to our eyes, and the thing that inspired ``blue``.
We strongly prefer using single quoted strings over double quoted strings for
everything *except* docstrings and triple quoted strings (TQS). Don't ask us
why we prefer double-quotes for TQS; it just looks better to us! For all
other strings, ``blue`` defaults to single quoted strings. In the case of
docstrings, those always use TQS with double-quotes.
* ``blue`` defaults to line lengths of 79 characters. Nearly every project
creates a pyproject.toml just to change this one setting so making it
consistent with PEP 8 seems relatively harmless.
* ``blue`` preserves the whitespace before the hash mark for right hanging
comments.
* ``blue`` supports multiple config files: ``pyproject.toml``, ``setup.cfg``,
``tox.ini``, and ``.blue``.
We are `accumulating <https://github.com/grantjenks/blue/issues/2>`_ a list of
other deviations we are considering. As we decide to implement any particular
suggestion, we'll turn those into individual issues and tackle them
one-by-one. If you have suggestions for other deviations from ``black``'s
choices, please open a separate ticket on our tracker, and we'll see how it
goes!
Why "blue"?
===========
Several reasons! If your formatter is going to beat up your code, it'll leave
it black and blue, or maybe in this case, black *or* blue. Blue is better!
We also thought about "tan" because, yum! But that project name was already
taken. Frankly, "blue" was also taken, but largely unused. Our thanks to
Nick Ficano for donating the project namespace to us!
Blue is also the color of `LinkedIn <https://www.linkedin.com/>`_, the
authors' gracious employer, and we intend to socialize its use within our
company code base.
Contributors
============
``blue`` thanks this list of contributors for all its wonderful goodness.
* The `wonderful folks <https://github.com/psf/black#authors>`_ from the
``black`` project.
* Grant Jenks
* Barry Warsaw
* Corey from FutureSpaceDesigns for the unofficial logo and `blue project
merchandise <https://www.teepublic.com/t-shirt/6556561-tobias-blue>`_.
``blue`` is licensed under the terms of the Apache License Version 2.0.
``black`` is `licensed <https://github.com/psf/black#license>`_ under the
terms of the MIT license.
Project details
===============
.. image:: https://img.shields.io/badge/code%20style-blue-blue.svg
:target: https://blue.readthedocs.io/
.. image:: https://github.com/grantjenks/blue/workflows/integration/badge.svg
:target: https://github.com/grantjenks/blue/actions?query=workflow%3Aintegration
.. image:: https://github.com/grantjenks/blue/workflows/release/badge.svg
:target: https://github.com/grantjenks/blue/actions?query=workflow%3Arelease
* Project home: https://github.com/grantjenks/blue
* Report bugs and suggestions at: https://github.com/grantjenks/blue/issues
* Code hosting: https://github.com/grantjenks/blue.git
* Documentation: https://blue.readthedocs.io/en/latest
* Try it out: https://iblueit.dev
Raw data
{
"_id": null,
"home_page": "https://blue.readthedocs.io/",
"name": "blue",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Grant Jenks",
"author_email": "contact@grantjenks.com",
"download_url": "https://files.pythonhosted.org/packages/68/5a/ef15e7accbe49dbeeb8e7c01e13b8459006c6fed4db8fe833f2ae4924fd7/blue-0.9.1.tar.gz",
"platform": null,
"description": "====\nBlue\n====\n\nSome folks like `black <https://black.readthedocs.io/en/stable/>`_ but I\nprefer `blue <https://blue.readthedocs.io/en/latest/>`_.\n\n\nWhat is blue?\n=============\n\n``blue`` is a somewhat less uncompromising code formatter than ``black``, the\nOG of Python formatters. We love the idea of automatically formatting Python\ncode, for the same reasons that inspired ``black``, however we take issue with\nsome of the decisions ``black`` makes. Kudos to ``black`` for pioneering code\nformatting for Python, and for its excellent implementation.\n\nWhere the ``blue`` maintainers disagree with the stylistic (and\nunconfigurable) choices made by ``black``, we monkeypatch to change these\ndecisions to our own liking. We intend for these differences to be minimal;\neven in cases where we'd prefer something different, there's a lot we can live\nwith for the sake of consistency.\n\nWe'd prefer not to fork or monkeypatch. Instead, our hope is that eventually\nwe'll be able to work with the ``black`` maintainers to add just a little bit\nof configuration and merge back into the ``black`` project. We'd be ecstatic\nif ``blue`` eventually were retired. Until then, we'll maintain our small set\nof hacks on top of ``black`` and carefully consider what other deviations are\nneeded to assuage our sensitive, but experienced, eye.\n\n\nHow do I use blue?\n==================\n\nExactly the same as you would use ``black``. Invoke and configure ``blue`` as\nyou would ``black`` -- just replace the ``black`` command with ``blue``, sit\nback, and enjoy even betterly formatted Python code! You can refer to\n`black's <https://black.readthedocs.io/en/stable/>`_ documentation for\nanything not listed here.\n\nTry it out now using `iblueit.dev <https://iblueit.dev/>`_.\n\nSo what's different?\n====================\n\nHere is a brief list of differences between ``blue`` and ``black``:\n\n* ``blue`` defaults to single-quoted strings. This is probably the most\n painful ``black`` choice to our eyes, and the thing that inspired ``blue``.\n We strongly prefer using single quoted strings over double quoted strings for\n everything *except* docstrings and triple quoted strings (TQS). Don't ask us\n why we prefer double-quotes for TQS; it just looks better to us! For all\n other strings, ``blue`` defaults to single quoted strings. In the case of\n docstrings, those always use TQS with double-quotes.\n\n* ``blue`` defaults to line lengths of 79 characters. Nearly every project\n creates a pyproject.toml just to change this one setting so making it\n consistent with PEP 8 seems relatively harmless.\n\n* ``blue`` preserves the whitespace before the hash mark for right hanging\n comments.\n\n* ``blue`` supports multiple config files: ``pyproject.toml``, ``setup.cfg``,\n ``tox.ini``, and ``.blue``.\n\nWe are `accumulating <https://github.com/grantjenks/blue/issues/2>`_ a list of\nother deviations we are considering. As we decide to implement any particular\nsuggestion, we'll turn those into individual issues and tackle them\none-by-one. If you have suggestions for other deviations from ``black``'s\nchoices, please open a separate ticket on our tracker, and we'll see how it\ngoes!\n\n\nWhy \"blue\"?\n===========\n\nSeveral reasons! If your formatter is going to beat up your code, it'll leave\nit black and blue, or maybe in this case, black *or* blue. Blue is better!\n\nWe also thought about \"tan\" because, yum! But that project name was already\ntaken. Frankly, \"blue\" was also taken, but largely unused. Our thanks to\nNick Ficano for donating the project namespace to us!\n\nBlue is also the color of `LinkedIn <https://www.linkedin.com/>`_, the\nauthors' gracious employer, and we intend to socialize its use within our\ncompany code base.\n\n\nContributors\n============\n\n``blue`` thanks this list of contributors for all its wonderful goodness.\n\n* The `wonderful folks <https://github.com/psf/black#authors>`_ from the\n ``black`` project.\n* Grant Jenks\n* Barry Warsaw\n* Corey from FutureSpaceDesigns for the unofficial logo and `blue project\n merchandise <https://www.teepublic.com/t-shirt/6556561-tobias-blue>`_.\n\n``blue`` is licensed under the terms of the Apache License Version 2.0.\n``black`` is `licensed <https://github.com/psf/black#license>`_ under the\nterms of the MIT license.\n\n\nProject details\n===============\n\n.. image:: https://img.shields.io/badge/code%20style-blue-blue.svg\n :target: https://blue.readthedocs.io/\n\n.. image:: https://github.com/grantjenks/blue/workflows/integration/badge.svg\n :target: https://github.com/grantjenks/blue/actions?query=workflow%3Aintegration\n\n.. image:: https://github.com/grantjenks/blue/workflows/release/badge.svg\n :target: https://github.com/grantjenks/blue/actions?query=workflow%3Arelease\n\n* Project home: https://github.com/grantjenks/blue\n* Report bugs and suggestions at: https://github.com/grantjenks/blue/issues\n* Code hosting: https://github.com/grantjenks/blue.git\n* Documentation: https://blue.readthedocs.io/en/latest\n* Try it out: https://iblueit.dev\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Blue -- Some folks like black but I prefer blue.",
"version": "0.9.1",
"project_urls": {
"Documentation": "https://blue.readthedocs.io/en/latest",
"Homepage": "https://blue.readthedocs.io/",
"Source": "https://github.com/grantjenks/blue.git",
"Tracker": "https://github.com/grantjenks/blue/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c57be6bfbe69b8b22abbfbdd993142bcabd1b2ce237a42c250181c5152052feb",
"md5": "6859e8e3ad9f0145264621cb1b47d6e4",
"sha256": "037742c072c58a2ff024f59fb9164257b907f97f8f862008db3b013d1f27cc22"
},
"downloads": -1,
"filename": "blue-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6859e8e3ad9f0145264621cb1b47d6e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10590,
"upload_time": "2022-08-01T16:38:51",
"upload_time_iso_8601": "2022-08-01T16:38:51.556102Z",
"url": "https://files.pythonhosted.org/packages/c5/7b/e6bfbe69b8b22abbfbdd993142bcabd1b2ce237a42c250181c5152052feb/blue-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "685aef15e7accbe49dbeeb8e7c01e13b8459006c6fed4db8fe833f2ae4924fd7",
"md5": "b36a961280d8ba46ab83103b8ef9b1af",
"sha256": "76b4f26884a8425042356601d80773db6e0e14bebaa7a59d7c54bf8cef2e2af5"
},
"downloads": -1,
"filename": "blue-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "b36a961280d8ba46ab83103b8ef9b1af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10594,
"upload_time": "2022-08-01T16:38:53",
"upload_time_iso_8601": "2022-08-01T16:38:53.798743Z",
"url": "https://files.pythonhosted.org/packages/68/5a/ef15e7accbe49dbeeb8e7c01e13b8459006c6fed4db8fe833f2ae4924fd7/blue-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-08-01 16:38:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grantjenks",
"github_project": "blue",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "blue"
}
