Notes for quasar developers
===========================

| Written by Piotr P. Nikiel, Nov 2019

Conventions regarding Python code for quasar tooling
----------------------------------------------------

| The note here applies to people developing quasar scripting, like
  quasar.py and other py scripts in the FrameworkInternals directory.

Indentation
-----------

| Developers should follow
  `PEP8 <https://www.python.org/dev/peps/pep-0008/#indentation>`__.

| Note that there is some tooling which can help maintain proper
  indentation, for instance we recommend autopep8.
| The way to invoke it might be:

::

   find . -name \*.py -exec autopep8 --select E101,W291,W293 -i {} \;

| 

Line ending encoding
--------------------

| 
| You should use LF line endings. You can use dos2unix if in need.

Encoding
--------

| 
| You should use UTF-8.

Shebang
-------

| 
| You should use the following shebang:

::

   #!/usr/bin/env python