Skeleton python2/3 application that uses Flask, implements authentication with some bare-bones user management, uses MongoDB for the backend and Twitter Bootstrap for the frontend. Purpose of the application is to provide a quick way to spin up new ideas or test out concepts without having to code the usual details.
Start redis:
$ redis-server
Start RabbiqMQ:
$ rabbitmq-server
Start the Celery beat:
$ sudo celery worker -A celery_worker.celery --loglevel=info -B
.. role:: small
Inline markup allows words and phrases within text to have character styles (like italics and boldface) and functionality (like hyperlinks).
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| emphasis | emphasis |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| strong emphasis | strong emphasis |
+----------------------------------------------------------+------------------------------------------------+
| :: | The rendering and meaning of interpreted text |
| | is domain- or application-dependent. |
| interpreted text | |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| inline literal | inline literal |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| reference_ | reference_ |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| phrase reference_ | phrase reference_ |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| anonymous__ | anonymous__ |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| inline internal target | inline internal target |
+----------------------------------------------------------+------------------------------------------------+
| :: | The result is substituted in from the |
| | substitution definition. |
| |substitution reference| | |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| footnote reference [1] | footnote reference [1] |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| citation reference [CIT2002]_ | citation reference [CIT2002]_ |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| http://docutils.sf.net/ | http://docutils.sf.net/ |
+----------------------------------------------------------+------------------------------------------------+
__ http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets
.. _reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets
.. _phrase reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets
reStructuredText uses backslashes ("\") to override the special meaning given to markup characters and get the literal characters themselves. To get a literal backslash, use an escaped backslash ("\\"). For example:
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| escape with "" | escape with "" |
+----------------------------------------------------------+------------------------------------------------+
| :: | |
| | |
| *escape* ``with "\\" | \*escape* \with`` "\" |
+----------------------------------------------------------+------------------------------------------------+
+----------------------------------------------------------+------------------------------------------------------+ | :: | | | | | | - This is item 1. A blank line before the first | - This is item 1. A blank line before the first | | and last items is required. | and last items is required. | | - This is item 2 | - This is item 2 | | | | | - Item 3: blank lines between items are optional. | - Item 3: blank lines between items are optional. | | - Item 4: Bullets are "-", "" or "+". | - Item 4: Bullets are "-", "" or "+". | | Continuing text must be aligned after the bullet | Continuing text must be aligned after the bullet| | and whitespace. | and whitespace. | +----------------------------------------------------------+------------------------------------------------------+ | :: | | | | | | 3. This is the first item | 3. This is the first item | | 4. This is the second item | 4. This is the second item | | 5. Enumerators are arabic numbers, | 5. Enumerators are arabic numbers, | | single letters, or roman numerals | single letters, or roman numerals | | 6. List items should be sequentially | 6. List items should be sequentially | | numbered, but need not start at 1 | numbered, but need not start at 1 | | (although not all formatters will | (although not all formatters will | | honour the first index). | honour the first index). | | #. This item is auto-enumerated | #. This item is auto-enumerated | +----------------------------------------------------------+------------------------------------------------------+ | :: | | | | | | what | what | | Definition lists associate a term with | Definition lists associate a term with | | a definition. | a definition. | | | | | how | how | | The term is a one-line phrase, and the | The term is a one-line phrase, and the | | definition is one or more paragraphs or | definition is one or more paragraphs or | | body elements, indented relative to the | body elements, indented relative to the | | term. Blank lines are not allowed | term. Blank lines are not allowed | | between term and definition. | between term and definition. | +----------------------------------------------------------+------------------------------------------------------+ | :: | | | | | | :Authors: | :Authors: | | Tony J. (Tibs) Ibbs, | Tony J. (Tibs) Ibbs, | | David Goodger | David Goodger | | | | | (and sundry other good-natured folks) | (and sundry other good-natured folks) | | | | | :Version: 1.0 of 2001/08/08 | :Version: 1.0 of 2001/08/08 | | :Dedication: To my father. | :Dedication: To my father. | +----------------------------------------------------------+------------------------------------------------------+ | :: | | | | | | -a command-line option "a" | -a command-line option "a" | | -b file options can have arguments | -b file options can have arguments | | and long descriptions | and long descriptions | | --long options can be long also | --long options can be long also | | --input=file long options can also have | --input=file long options can also have | | arguments | arguments | | /V DOS/VMS-style options too | /V DOS/VMS-style options too | +----------------------------------------------------------+------------------------------------------------------+
.. raw:: pdf
Spacer 0 72
+----------------------------------------------------------+--------------------------------------------------------+
| :: | |
| | .. class:: faketitle |
| Title | |
| ===== | Title |
| | |
| Titles are underlined (or over- and underlined) with | Titles are underlined (or over- and underlined) with |
| a nonalphanumeric character at least as long as the | a nonalphanumeric character at least as long as the |
| text. | text. |
| | |
| A lone top-level section is lifted up to be the | A lone top-level section is lifted up to be the |
| document's title. | document's title. |
| | |
| Any non-alphanumeric character can be used, but | Any non-alphanumeric character can be used, but |
| Python convention is: | Python convention is: |
| | |
| * # with overline, for parts | * # with overline, for parts |
| * * with overline, for chapters | * * with overline, for chapters |
| * =, for sections | * =, for sections |
| * -, for subsections | * -, for subsections |
| * ^, for subsubsections | * ^, for subsubsections |
| * ", for paragraphs | * ", for paragraphs |
+----------------------------------------------------------+--------------------------------------------------------+
+---------------------------------------------------------------+------------------------------------------------------+
| :: | |
| | |
| This is a paragraph. | This is a paragraph. |
| | |
| Paragraphs line up at their left edges, and are | Paragraphs line up at their left |
| normally separated by blank lines. | edges, and are normally separated |
| | by blank lines. |
+---------------------------------------------------------------+------------------------------------------------------+
| :: | |
| | |
| A paragraph containing only two colons indicates | A paragraph containing only two colons |
| the following indented or quoted text is a literal | indicates that the following indented |
| block or quoted text is a literal block. | or quoted text is a literal block. |
| | |
| :: | :: |
| | |
| Whitespace, newlines, blank lines, and all kinds of | Whitespace, newlines, blank lines, and |
| markup (like this or \this) is preserved here. | all kinds of markup (like this or |
| | \this) is preserved by literal blocks. |
| You can also tack the :: at the end of a | |
| paragraph:: | You can also tack the :: at the end of a |
| | paragraph:: |
| It's very convenient to use this form. | |
| | It's very convenient to use this form. |
| Per-line quoting can also be used for unindented | |
| blocks:: | Per-line quoting can also be used for |
| | unindented blocks:: |
| > Useful for quotes from email and | |
| > for Haskell literate programming. | > Useful for quotes from email and |
| | > for Haskell literate programming. |
+---------------------------------------------------------------+------------------------------------------------------+
| :: | |
| | |
| | Line blocks are useful for addresses, | | Line blocks are useful for addresses, |
| | verse, and adornment-free lists. | | verse, and adornment-free lists. |
| | | | |
| | Each new line begins with a | | Each new line begins with a |
| | vertical bar ("|"). | | vertical bar ("|"). |
| | Line breaks and initial indents | | Line breaks and initial indents |
| | are preserved. | | are preserved. |
| | Continuation lines are wrapped | | Continuation lines are wrapped |
| portions of long lines; they begin | portions of long lines; they begin |
| with spaces in place of vertical bars. | with spaces in place of vertical bars. |
+---------------------------------------------------------------+------------------------------------------------------+
| :: | |
| | |
| Block quotes are just: | Block quotes are just: |
| | |
| Indented paragraphs, | Indented paragraphs, |
| | |
| and they may nest. | and they may nest. |
+---------------------------------------------------------------+------------------------------------------------------+
| :: | |
| | |
| Doctest blocks are interactive | Doctest blocks are interactive |
| Python sessions. They begin with | Python sessions. They begin with |
| ">>>" and end with a blank line. | ">>>" and end with a blank line. |
| | |
| >>> print "This is a doctest block." | >>> print "This is a doctest block." |
| This is a doctest block. | This is a doctest block. |
+---------------------------------------------------------------+------------------------------------------------------+
| :: | |
| | |
| A transition marker is a horizontal line | A transition marker is a horizontal line |
| of 4 or more repeated punctuation | of 4 or more repeated punctuation |
| characters. | characters. |
| | |
| ------------ | .. class:: faketrans |
| | |
| A transition should not begin or end a | +-----------+ |
| section or document, nor should two | | | |
| transitions be immediately adjacent. | +-----------+ |
| | |
| | |
| | A transition should not begin or end a |
| | section or document, nor should two |
| | transitions be immediately adjacent. |
+---------------------------------------------------------------+------------------------------------------------------+
.. raw:: pdf
PageBreak
There are two syntaxes for tables in reStructuredText. Grid tables are complete but cumbersome to create. Simple tables are easy to create but limited (no row spans, etc.).
+---------------------------------------------------------------+------------------------------------------------------+ | :: | | | | .. class:: exampletable1 | | | | | +------------+------------+-----------+ | +------------+------------+-----------+ | | | Header 1 | Header 2 | Header 3 | | | Header 1 | Header 2 | Header 3 | | | +============+============+===========+ | +============+============+===========+ | | | body row 1 | column 2 | column 3 | | | body row 1 | column 2 | column 3 | | | +------------+------------+-----------+ | +------------+------------+-----------+ | | | body row 2 | Cells may span columns.| | | body row 2 | Cells may span columns.| | | +------------+------------+-----------+ | +------------+------------+-----------+ | | | body row 3 | Cells may | - Cells | | | body row 3 | Cells may | - Cells | | | +------------+ span rows. | - contain | | +------------+ span rows. | - contain | | | | body row 4 | | - blocks. | | | body row 4 | | - blocks. | | | +------------+------------+-----------+ | +------------+------------+-----------+ | +---------------------------------------------------------------+------------------------------------------------------+ | :: | | | | .. class:: exampletable1 | | | | | ===== ===== ====== | ===== ===== ====== | | Inputs Output | Inputs Output | | ------------ ------ | ------------ ------ | | A B A or B | A B A or B | | ===== ===== ====== | ===== ===== ====== | | False False False | False False False | | True False True | True False True | | False True True | False True True | | True True True | True True True | | ===== ===== ====== | ===== ===== ====== | +---------------------------------------------------------------+------------------------------------------------------+
Explicit markup blocks are used for constructs which float (footnotes), have no direct paper-document representation (hyperlink targets, comments), or require specialized processing (directives). They all begin with two periods and whitespace, the "explicit markup start".
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| Footnote references, like [5]. | Footnote references, like [5]. |
| Note that footnotes may get | Note that footnotes may get |
| rearranged, e.g., to the bottom of | rearranged, e.g., to the bottom of |
| the "page". | the "page". |
| | |
| .. [5] A numerical footnote. Note | .. [5] A numerical footnote. Note |
| there's no colon after the ]. | there's no colon after the ]. |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| Autonumbered footnotes are | Autonumbered footnotes are |
| possible, like using [#]_ and [#]. | possible, like using [#] and [#]. |
| | |
| .. [#] This is the first one. | .. [#] This is the first one. |
| .. [#] This is the second one. | .. [#] This is the second one. |
| | |
| They may be assigned 'autonumber | They may be assigned 'autonumber |
| labels' - for instance, | labels' - for instance, |
| [#fourth] and [#third]. | [#fourth] and [#third]. |
| | |
| .. [#third] a.k.a. third | .. [#third] a.k.a. third_ |
| | |
| .. [#fourth] a.k.a. fourth_ | .. [#fourth] a.k.a. fourth_ |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| Auto-symbol footnotes are also | Auto-symbol footnotes are also |
| possible, like this: []_ and []. | possible, like this: [*] and []_. |
| | |
| .. [] This is the first one. | .. [] This is the first one. |
| .. [] This is the second one. | .. [*] This is the second one. |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| Citation references, like [CIT2002]. | Citation references, like [CIT2002]. |
| Note that citations may get | Note that citations may get |
| rearranged, e.g., to the bottom of | rearranged, e.g., to the bottom of |
| the "page". | the "page". |
| | |
| .. [CIT2002] A citation | .. [CIT2002] A citation |
| (as often used in journals). | (as often used in journals). |
| | |
| Citation labels contain alphanumerics, | Citation labels contain alphanumerics, |
| underlines, hyphens and fullstops. | underlines, hyphens and fullstops. |
| Case is not significant. | Case is not significant. |
| | |
| Given a citation like [this], one | Given a citation like [this], one |
| can also refer to it like this_. | can also refer to it like this_. |
| | |
| .. [this] here. | .. [this] here. |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| External hyperlinks, like Python_. | External hyperlinks, like Python_. |
| | |
| .. Python: http://www.python.org/ | .. Python: http://www.python.org/ |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| External hyperlinks, like Python | External hyperlinks, like Python |
| http://www.python.org/_. | <http://www.python.org/>. |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| Internal crossreferences, like example. | Internal crossreferences, like example_. |
| | |
| .. example: | .. example: |
| | |
| This is an example crossreference target. | This is an example crossreference target. |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| Python is my favourite | Python_ is my favourite |
| programming language__. | programming language__. |
| | |
| .. Python: http://www.python.org/ | .. Python: http://www.python.org/ |
| | |
| __ Python | __ Python |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | .. titles are targets, too: |
| | .. class:: faketitle |
| Titles are targets, too | |
| ======================= | Titles are targets, too |
| | |
| Implict references, like Titles are targets, too. | Implict references, like |
| | Titles are targets, too. |
+---------------------------------------------------------------+-------------------------------------------------------------+
| |
|Directives are a general-purpose extension mechanism, a way of adding support for new constructs without adding |
|new syntax. For a description of all standard directives, see reStructuredText Directives (http://is.gd/2Ecqh). |
| |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| For instance: | For instance: |
| | |
| .. image:: magnetic-balls.jpg | .. image:: magnetic-balls.jpg |
| :width: 40pt | :width: 40pt |
| | |
+---------------------------------------------------------------+-------------------------------------------------------------+
| |
| |
| Substitutions are like inline directives, allowing graphics and arbitrary constructs within text. |
| |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| The |biohazard| symbol must be used on containers used to | The |biohazard| symbol must be used on containers used to |
| dispose of medical waste. | dispose of medical waste. |
| | |
| .. |biohazard| image:: biohazard.png | .. |biohazard| image:: biohazard.png |
| :align: middle | :align: middle |
| :width: 12 | :width: 12 |
+---------------------------------------------------------------+-------------------------------------------------------------+
| |
| Any text which begins with an explicit markup start but doesn't use the syntax of any of the constructs above, is a comment.|
| |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| .. This text will not be shown | .. This text will not be shown |
| (but, for instance, in HTML might be | (but, for instance, in HTML might be |
| rendered as an HTML comment) | rendered as an HTML comment) |
+---------------------------------------------------------------+-------------------------------------------------------------+
| :: | |
| | |
| An "empty comment" does not | An "empty comment" does not |
| consume following blocks. | consume following blocks. |
| (An empty comment is ".." with | (An empty comment is ".." with |
| blank lines before and after.) | blank lines before and after.) |
| | |
| .. | .. |
| | |
| So this block is not "lost", | So this block is not "lost", |
| despite its indentation. | despite its indentation. |
+---------------------------------------------------------------+-------------------------------------------------------------+
.. class:: tablacreditos
+---------------------------------------+-------------------------------------------------------+ | CP Font from LiquiType: | http://www.liquitype.com/workshop/type_design/cp-mono | +---------------------------------------+-------------------------------------------------------+ | Magnetic Balls V2 image by fdecomite: | http://www.flickr.com/photos/fdecomite/2926556794/ | +---------------------------------------+-------------------------------------------------------+ | Sponsored by Net Managers | http://www.netmanagers.com.ar | +---------------------------------------+-------------------------------------------------------+ | Typeset using rst2pdf | http://rst2pdf.googlecode.com | +---------------------------------------+-------------------------------------------------------+
.. footer::
.. class:: tablapie
+-------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+----------------------------------+-----------------------------------+
| |copy| :small:`2009 Roberto Alsina <ralsina@netmanagers.com.ar> / Creative Commons Attribution-Noncommercial-Share Alike 2.5 Argentina License` | |attrib| :small:`Based on quickref.txt from docutils` | |noncomm| :small:`Non-Commercial`| |sharealike| :small:`Share Alike` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+----------------------------------+-----------------------------------+
.. |attrib| image:: attrib.png :width: 8pt :align: middle
.. |noncomm| image:: noncomm.png :width: 8pt :align: middle
.. |sharealike| image:: sharealike.png :width: 8pt :align: middle
.. |copy| unicode:: U+000A9
