⛩ Style
========

TL;DR
______
Read PEP8 and the `Google Styleguide`_ for a general orientation. Most rules should be check by our tooling.

Style
_____
.. note::

    This guide is a work in progress, so if you see something which isn't addressed or should be changed
    feel free to crate a Issue/PR to start a discussion on the topic.

    .. attention::

        Please search the Issues & PR's beforehand, to make sure that your case
        is bringing something new to the table.

How to apply style & coding conventions
---------------------------------------

#. Apply formatters and linters
#. Check if we have defined an explicit rule on this in the styleguide
#. Consult the `Google Styleguide`_
#. Consult `PEP 8`_


Idioms
_______

.. toctree::
   :maxdepth: 2

   idioms/idioms


References & Further Reading
____________________________
* `Google Styleguide`_
* `PEP 8 <https://peps.python.org/pep-0008/>`_
* `Python Idioms`_
* `Python Like You Mean It`_
* `Python Programming Idioms`_

Talks
_____
* `Transform Code into Beautiful, Idiomatic Python`_
* `Stop Writing Classes`_
* `Refactoring Python`_

.. _Raymond Hettinger: https://github.com/rhettinger

.. _Google Styleguide: https://google.github.io/styleguide/pyguide.html
.. _PEP 8: https://peps.python.org/pep-0008/
.. _Python Idioms: https://gist.github.com/0x4D31/f0b633548d8e0cfb66ee3bea6a0deff9
.. _Python Like You Mean It: http://www.pythonlikeyoumeanit.com/module_2.html>
.. _Python Programming Idioms: https://en.wikibooks.org/wiki/Python_Programming/Idioms

.. _Transform Code into Beautiful, Idiomatic Python: https://www.youtube.com/watch?v=OSGv2VnC0go>
.. _Transform Python Slides: https://speakerdeck.com/pyconslides/transforming-code-into-beautiful-idiomatic-python-by-raymond-hettinger-1
.. _Stop Writing Classes: https://www.youtube.com/watch?v=o9pEzgHorH0
.. _Refactoring Python: https://www.youtube.com/watch?v=D_6ybDcU5gc