disLEXia

Things to keep in Mind when writing code for me:

* Follow PEP 8, verify with pep8.py
* Follow PEP 257 for docstrings. Always use Docstrings.
* No tabs. Not anywhere. Always indent with 4 spaces.
* Wrap at Column 109
* Use pylint aim for a score of at least 8.
* Add a Header to each file stating that the file is utf-8 encoded and add creation date and your name.
* Write doctests where possible. Always write unittests. Aim for a test coverage of at least 80%
* Code should be targeted at Python 2.6 on FreeBSD/Linux
* if you need a Javascript Library, use jQuery 1.3.x
* Make your code Unicode clean. Suggested Test-Data: Iñtërnâtiônàlîzætiøñ
* Avoid non-native Python extensions where possible
* add a reqirements.txt file for use with pip and a setuo.py for the use with distutils
* Add CHANGES and README file with appropriate content. Target Audicnce are experienced developers and administrators.
* Add a Makefile with the targets test, coverage, check (pylint, pep8), install
* Webpages should be plain white HTML pages containing the needed forms/UI unless otherwise stated
* Use PostgreSQL and SQLite. If you prefer you can use CouchDB instead.
* Use OpenSource Libraries where they are available. If you copy OpenSource code please mark it clearly and mention the License of the the included code.
* Copyright of the Code written by you for the project will be assigned to us. We might OpenSource the code if we consider it of general interest.
* During development you will not get access to our servers, accounts, resources. Installation will be handled by us according to the documentation we provided.
* Classes/Variables which reference Objects specific to our ERP/our Industry/german trade should be in german as technical terms. Generic Objects should be named in english: Lieferscheinnummer, Kundenauftragsnumer, Rechnung but TransportEndpoint and DataStore. This line is very blurry. Comments in the code should be in english or german.

~/.pylintrc:

[FORMAT]
max-line-length=110