1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
************
Hacking MaaS
************
Coding style
============
MaaS follows the `Launchpad Python Style Guide`_, except where it gets
Launchpad specific, and where it talks about `method naming`_. MaaS
instead adopts `PEP-8`_ naming in all cases, so method names should
usually use the ``lowercase_with_underscores`` form.
.. _Launchpad Python Style Guide:
https://dev.launchpad.net/PythonStyleGuide
.. _method naming:
https://dev.launchpad.net/PythonStyleGuide#Naming
.. _PEP-8:
http://www.python.org/dev/peps/pep-0008/
Development MaaS server setup
=============================
Access to the database is configured in ``src/maas/development.py``.
The ``Makefile`` or the test suite sets up a development database
cluster inside your branch. It lives in the ``db`` directory, which
gets created on demand. You'll want to shut it down before deleting a
branch; see below.
First, set up the project. This fetches all the required dependencies
and sets up some useful commands in ``bin/``::
$ make
Create the database cluster and initialize the development database::
$ make syncdb
Run the development webserver::
$ make run
Optionally, populate your database with the sample data::
$ make sampledata
Point your browser to http://localhost:8000/
If you've populated your instance with the sample data, you can login as a
simple user using the test account (username: 'test', password: 'test') or the
admin account (username: 'admin', password: 'test').
To shut down the database cluster and clean up all other generated files in
your branch::
$ make distclean
Adding new source files
=======================
When creating a new source file, a Python module or test for example,
always start with the appropriate template from the ``templates``
directory.
Documentation
=============
Use `reST`_ with the `convention for headings as used in the Python
documentation`_.
.. _reST: http://sphinx.pocoo.org/rest.html
.. _convention for headings as used in the Python documentation:
http://sphinx.pocoo.org/rest.html#sections
|