changeset 14:df32c1d01b8d

Dodałem edycję zadań przez POST, napisałem coś w rodzaju dokumentacji z nudów
author Michał Rudowicz <michal.rudowicz@fl9.eu>
date Fri, 01 Apr 2011 22:58:29 +0200
parents 79cf8ca2a0e5
children 914d508e87c8
files frontend/config.ini frontend/doc/Makefile frontend/doc/api.txt frontend/doc/conf.py frontend/doc/config.ini frontend/doc/config.txt frontend/doc/index.txt frontend/doc/make.bat frontend/doc/quickstart.txt frontend/mfrontend/db.py frontend/mfrontend/views/api.py
diffstat 11 files changed, 710 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/frontend/config.ini	Fri Apr 01 19:02:08 2011 +0200
+++ b/frontend/config.ini	Fri Apr 01 22:58:29 2011 +0200
@@ -8,4 +8,4 @@
 # Algorytm wyliczający hashe dla haseł
 HashCrypto = sha1
 # Klucz API
-ApiKey = TajnyKluczApi
+ApiKey = apikey
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/Makefile	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Frontend.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Frontend.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Frontend"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Frontend"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/api.txt	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,54 @@
+Porady dla osób korzystających z API
+====================================
+
+Pobieranie informacji o zadaniu o danym ID
+------------------------------------------
+
+Przy domyślnej konfiguracji pobranie danych o zadaniu o podanym ID wymaga
+wykonania polecenia GET na elemencie pod adresem
+``/api/getjob/<apikey>/<ID>/``, gdzie:
+
+apikey
+    Klucz API taki, jak ustawiony w pliku config.ini
+ID
+    Identyfikator zadania
+
+Serwer aplikacji powinien zwrócić dokument w formacie JSON zawierający
+wszystkie dane znajdujące się w bazie, dotyczące tego zadania.
+
+Pobieranie informacji o wszystkich zadaniach
+--------------------------------------------
+
+``/api/getjob/<apikey>/`` , gdzie *apikey* ma takie samo znaczenie jak
+powyżej.
+
+Pobieranie jednego oczekującego zadania
+---------------------------------------
+
+``/api/getnextjob/<apikey>/`` pobiera następne oczekujące działanie (wg numeru ID,
+najpierw mniejsze wartości). *Ważne*: samo pobranie informacji **nie** zmienia
+statusu zadania, trzeba to zrobić ręcznie za pomocą edycji zadania.
+
+Modyfikowanie danych zadania
+----------------------------
+
+Należy wykonać *POST* na URI ``/api/modify/<apikey/<jobid>/``, gdzie:
+
+apikey
+    Klucz API z pliku config.ini
+ID
+    Identyfikator zadania
+
+Natomiast jako dane POST należy przesłać nowe wartości, które chcemy wpisać do
+bazy, przykładowo następująca linia poleceń programu CURL:
+
+    curl --data "state=10&percent=40" localhost:5000/api/modify/apikey/1/ ::
+
+spowoduje ustawienie wartości ``state`` na 10 i ``percent`` na 40 przy zadaniu
+o identyfikatorze ``1`.
+
+Funkcje wykorzystywane w API
+----------------------------
+
+.. automodule:: mfrontend.views.api
+    :members:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/conf.py	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,217 @@
+# -*- coding: utf-8 -*-
+#
+# Frontend documentation build configuration file, created by
+# sphinx-quickstart on Fri Apr  1 21:55:46 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Frontend'
+copyright = u'2011, Michał Rudowicz'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0'
+# The full version, including alpha/beta/rc tags.
+release = '0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = "pl"
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+sys.path.append(os.path.abspath('..'))
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Frontenddoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'Frontend.tex', u'Frontend Documentation',
+   u'Michał Rudowicz', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'frontend', u'Frontend Documentation',
+     [u'Michał Rudowicz'], 1)
+]
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/config.ini	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,7 @@
+[Basic]
+database = baza.sqlite
+debug = 0
+secret_key = xyeURm3nG7
+hashcrypto = sha512
+apikey = bCVqxeFexh
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/config.txt	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,38 @@
+.. _config-ini:
+
+Plik konfiguracyjny
+===================
+
+Przykładowy plik konfiguracyjny
+-------------------------------
+::
+
+    [Basic]
+    # W przypadku sqlite, ścieżka do pliku bazy
+    Database = baza.sqlite
+    # Wygenerować losowy dla każdej instalacji bazy
+    Secret_Key = TakBardzoTajne
+    # Dla poważnej instalacji ustawić na 0
+    Debug = 1
+    # Algorytm wyliczający hashe dla haseł
+    HashCrypto = sha1
+    # Klucz API
+    ApiKey = apikey
+
+Opis pól w pliku konfiguracyjnym
+--------------------------------
+
+Database
+    Nazwa pliku zawierającego bazę danych.
+Secret_Key
+    Tajny plucz. Podczas automatycznego tworzenia pliku konfiguracyjnego
+    generowany jest losowy 10-znakowy klucz.
+Debug
+    Powoduje wyświetlanie informacji o debugowaniu w przypadku błędu
+    aplikacji. **UWAGA:** W przypadku poważnych instalacji należy ustawić na
+    0, ponieważ na stronie z informacjami o debugowaniu wyświetlana jest
+    również konsola debugowania, co jest bardzo niebezpieczne.
+HashCrypto
+    Algorytm hashowania haseł w bazie.
+ApiKey
+    Klucz API.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/index.txt	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,22 @@
+.. Frontend documentation master file, created by
+   sphinx-quickstart on Fri Apr  1 21:55:46 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Witamy w dokumentacji Serwera Aplikacji!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+
+   quickstart
+   config
+   api
+
+Zobacz też
+==========
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/make.bat	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,170 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Frontend.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Frontend.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/quickstart.txt	Fri Apr 01 22:58:29 2011 +0200
@@ -0,0 +1,32 @@
+Szybki Start
+============
+
+Wymagania
+---------
+
+Serwer aplikacji wymaga Pythona, Flaska, Sqlite3 i to chyba wszystko. W każdym
+bądź razie wszystko, prócz wymienionych elementów, instaluje się domyślnie z
+Pythonem na openSUSE i Ubuntu.
+
+Instalacja Flaska sprowadza się do wydania polecenia::
+
+    $ easy_install Flask
+
+Uruchomienie serwera aplikacji
+------------------------------
+
+Serwer aplikacji uruchamiamy za pomocą polecenia
+
+    python runserver.py ::
+
+Domyślnie serwer będzie nasłuchiwał na porcie 5000.
+
+:ref:`config-ini` ``config.ini`` zostanie stworzony w bieżącym katalogu. 
+
+Tworzenie bazy danych
+---------------------
+
+Stworzenie nowej, pustej bazy danych według schematu wymaga odwiedzenia w
+przeglądarce adresu ``/install/``. Po poprawnej instalacji w katalogu głównym
+zostanie stworzony pusty plik ``.install``, którego istnienie zapobiegnie
+ponownemu uruchomieniu procesu instalacji.
--- a/frontend/mfrontend/db.py	Fri Apr 01 19:02:08 2011 +0200
+++ b/frontend/mfrontend/db.py	Fri Apr 01 22:58:29 2011 +0200
@@ -136,14 +136,28 @@
     """ Funkcja zwraca wszystkie informacje o wybranym zadaniu na podstawie
         numeru identyfikacyjnego.
         @param job_id Identyfikator żądanego zadania
-        @return Informacje o żądanym zadaniu.
+        @return Informacje o żądanym zadaniu.;q
     """
-    return query_db("SELECT * FROM jobs WHERE id = ?",
+    return query_db("SELECT * FROM jobs WHERE id = ?;",
                    [job_id], one=True)
 
+def edit_job(job_id, options):
+    """ Funkcja omdyfikująca właściwości zadania o podanym identyfikatorze.
+        @param  job_id  Identyfikator zadania, które chcemy zmodyfikować.
+        @param  options Słownik z nowymi wartościami kolumn w tabeli.
+    """
+    # klucze, których zmianę dopuszczamy
+    keys = ["label", "state", "result", "percent", "last_checked"]
+    for key in keys:
+       if key in options:
+           query_db("UPDATE jobs SET " + key + " = :value WHERE id = :id",
+                    {"value":options["state"],"id":job_id})
+    g.db.commit()
+
 def get_user_name(user_id):
     """ Funkcja pobiera nazwę użytkownika o podanym identyfikatorze.
-        @param user_id  Identyfikator użytkownika, którego nazwa jest pożądana.
+        
+        user_id -- Identyfikator użytkownika, którego nazwa jest pożądana.
         @return String zawierający nazwę użytkownika, lub None, jeśli użytkownik nie istnieje.
     """
     return query_db("SELECT username FROM users WHERE id = ?;",
--- a/frontend/mfrontend/views/api.py	Fri Apr 01 19:02:08 2011 +0200
+++ b/frontend/mfrontend/views/api.py	Fri Apr 01 22:58:29 2011 +0200
@@ -1,12 +1,15 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-from flask import jsonify, Module, abort
+from flask import jsonify, Module, abort, request
 from mfrontend import db, utils, exceptions, decorators
 api = Module(__name__)
 
 @api.route('/getjob/<apikey>/')
 def get_jobs():
+    """ Funkcja pobiera informacje o wszystkich zadaniach
+        i zwraca je w formacie JSON.
+    """
     if apikey != db.config.get('Basic', 'ApiKey'):
         abort(403)
     return jsonify(jobs = db.get_jobs(None, None, None))
@@ -15,8 +18,9 @@
 def get_first_waiting_job(apikey):
     """ Zwraca w formacie JSON informacje o pierwszym
         czekającym zadaniu.
-        @param apikey   Klucz API.
-        @return         Dane o zadaniu w formacie JSON.
+
+        :param apikey: Klucz API.
+        :returns: Dane o zadaniu w formacie JSON.
     """
     if apikey != db.config.get('Basic', 'ApiKey'):
         abort(403)
@@ -25,10 +29,9 @@
 @api.route('/getjob/<apikey>/<int:jobid>/')
 def get_job(apikey, jobid):
     """ Zwraca w formacie JSON informacje o podanym zadaniu.
-        Uwaga: użytkownik musi być zalogowany, aby móc pobrać
-        informację o zadaniu.
-        @param  jobid   Identyfikator żądanego zadania.
-        @return         Informacje o zadaniu w formacie JSON.
+        
+        :param jobid: Identyfikator żądanego zadania.
+        :param apikey: Klucz API
     """
     # jeśli klucz API jest niepoprawny, przerywamy
     if apikey != db.config.get('Basic','ApiKey'):
@@ -36,3 +39,15 @@
     # w innym przypadku zwracamy informacje o zadaniu
     return jsonify(job = db.get_job_by_id(jobid))
 
+@api.route('/modify/<apikey>/<int:jobid>/', methods=['POST'])
+def modify_job(apikey, jobid):
+    """ Funkcja pozwalająca na modyfikację wybranego
+        zadania.
+        
+        :param apikey: Klucz API
+        :param jobid:   Identyfikator zadania do zmodyfikowania
+    """
+    if apikey != db.config.get('Basic','ApiKey'):
+        abort(403)
+    db.edit_job(jobid, request.form)
+    return "OK"