ars / development notes.txt

Information about software useful for developers

----------------------------------------

DEVELOPMENT SOFTWARE
* IDE (Integrated Development Environment):
	Eclipse 3.7.1 (Indigo SR 1) with PyDev and MercurialEclipse
		http://www.eclipse.org/downloads/
		http://pydev.org/
		http://javaforge.com/project/HGE
		
* SCM (Source Code Management):
	Mercurial 1.7.5
		http://mercurial.selenic.com/

DOCUMENTATION GENERATION SOFTWARE
* API documentation generation tool
	epydoc 3.0.1
		http://epydoc.sourceforge.net/

* Automatic graph drawings generation
	graphviz 2.20.2
		http://www.graphviz.org/

TOOLS
* code analyzer and syntax checking
	pylint (for now, we will not accept the recommendation of using 4-space indentation instead of tabs)
		http://www.logilab.org/project/pylint
		command:
			pylint -d W0312 MyScript.py

CODE STYLE AND CONVENTIONS
* PEP 8 - Style Guide for Python Code
	http://www.python.org/dev/peps/pep-0008/
	
* Docstring Conventions
	http://www.python.org/dev/peps/pep-0257/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.