forked from shaba/openuds
259 lines
12 KiB
HTML
259 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
||
<title>UDS’s documentation — UDS 1.0 documentation</title>
|
||
|
||
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT: './',
|
||
VERSION: '1.0',
|
||
COLLAPSE_INDEX: false,
|
||
FILE_SUFFIX: '.html',
|
||
HAS_SOURCE: true
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
<link rel="top" title="UDS 1.0 documentation" href="#" />
|
||
<link rel="next" title="UDS at a glance" href="intro/overview.html" />
|
||
</head>
|
||
<body>
|
||
<div class="related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="intro/overview.html" title="UDS at a glance"
|
||
accesskey="N">next</a> |</li>
|
||
<li><a href="#">UDS 1.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="sphinxsidebar">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h3><a href="#">Table Of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">UDS’s documentation</a><ul>
|
||
<li><a class="reference internal" href="#first-steps">First Steps</a></li>
|
||
<li><a class="reference internal" href="#the-internals-of-uds">The internals of uds</a></li>
|
||
<li><a class="reference internal" href="#uds-open-source-project">UDS Open source project</a></li>
|
||
<li><a class="reference internal" href="#acknowledgements">Acknowledgements</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="intro/overview.html"
|
||
title="next chapter">UDS at a glance</a></p>
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/index.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
<div id="searchbox" style="display: none">
|
||
<h3>Quick search</h3>
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" />
|
||
<input type="submit" value="Go" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
<p class="searchtip" style="font-size: 90%">
|
||
Enter search terms or a module, class or function name.
|
||
</p>
|
||
</div>
|
||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body">
|
||
|
||
<div class="section" id="uds-s-documentation">
|
||
<span id="index"></span><h1>UDS’s documentation<a class="headerlink" href="#uds-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||
<p>This documentation is provided so we can understand (hopefully) UDS, its internals,
|
||
and everything about it.</p>
|
||
<p>Right now the documentation is not too ritch, but we are working on it so it will
|
||
get the needed level for this kind of project.</p>
|
||
<div class="section" id="first-steps">
|
||
<h2>First Steps<a class="headerlink" href="#first-steps" title="Permalink to this headline">¶</a></h2>
|
||
<ul>
|
||
<li><dl class="first docutils">
|
||
<dt><strong>From scratch:</strong></dt>
|
||
<dd><p class="first last"><a class="reference internal" href="intro/overview.html"><em>Overview</em></a> |
|
||
<a class="reference internal" href="intro/install.html"><em>Installation</em></a></p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
</div>
|
||
<div class="section" id="the-internals-of-uds">
|
||
<h2>The internals of uds<a class="headerlink" href="#the-internals-of-uds" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="development/architecture.html">UDS’s architecture</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/architecture.html#component-architecture">Component Architecture</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/architecture.html#functional-architecture">Functional Architecture</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="api/index.html">UDS’s core API</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="api/models.html">UDS Database Models</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/models/services.html">Service Related models</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/models/authentication.html">Authentication Related models</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/models/transport.html">Transport Related models</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/models/other.html">Other models</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/models/other.html#module-uds.models">Environment related</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/models/other.html#module-related">Module related</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/models/other.html#scheduling-and-background-workers-related">Scheduling and background workers related</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="api/modules.html">UDS Modules</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/modules/BaseModule.html">Base Module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/BaseModule.html#module-uds.core">BaseModule</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/BaseModule.html#environmentable">Environmentable</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/BaseModule.html#serializable">Serializable</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/BaseModule.html#userinterface">UserInterface</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/modules/FormFields.html">Form Fields</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/modules/ServiceModules.html">Service Modules</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/services/Provider.html">Provider interface</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/services/Service.html">Service interface</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/services/Publication.html">Publication interface</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/services/UserDeployment.html">UserDeployment interface</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/services/Exceptions.html">Service Exceptions</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="api/modules/AuthenticatorModule.html">Authenticator Modules</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="api/modules/auths/Authenticator.html">Authenticator Interface</a><ul class="simple">
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/samples/samples.html">UDS Modules Samples</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="development/samples/samples.html#service-sample">Service Sample</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="development/samples/services/whatisneeded.html">Needs for a service package</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="development/samples/services/Provider.html">Sample Service Provider</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="development/samples/services/Service.html">Sample service</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="development/samples/services/Publication.html">Sample publication</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="development/samples/services/DeployedServiceOne.html">Sample User Deployment One</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="development/samples/services/DeployedServiceTwo.html">Sample User Deployment Two</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="development/samples/samples.html#authenticator-sample">Authenticator Sample</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="development/samples/auths/Authenticator.html">Sample Authenticator</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="uds-open-source-project">
|
||
<h2>UDS Open source project<a class="headerlink" href="#uds-open-source-project" title="Permalink to this headline">¶</a></h2>
|
||
<ul>
|
||
<li><dl class="first docutils">
|
||
<dt><strong>Community:</strong></dt>
|
||
<dd><p class="first last"><a class="reference internal" href="development/contributing.html"><em>How to get involved</em></a> |
|
||
<a class="reference internal" href="development/repository.html"><em>The UDS source code repository</em></a></p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
</div>
|
||
<div class="section" id="acknowledgements">
|
||
<h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline">¶</a></h2>
|
||
<p>We want to thaks all the people that has contributed to de project, an also
|
||
other Open Source project used to improve this one.</p>
|
||
<p>List of other software used to build UDS:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><a class="reference external" href="http://www.djangoproject.com/">Django</a></li>
|
||
<li><a class="reference external" href="http://www.xml-rpc.net/">XML-RPC.NET Copyright (c) 2006 Charles Cook</a></li>
|
||
<li><a class="reference external" href="http://kde-look.org/content/show.php/Dark-Glass+reviewed?content=67902">Darkglass reworked graphics</a></li>
|
||
<li><a class="reference external" href="http://kde-look.org/content/show.php/Crystal+Project?content=60475">Crystal project</a></li>
|
||
<li><a class="reference external" href="http://south.aeracode.org/">South</a></li>
|
||
<li><a class="reference external" href="http://www.jcraft.com/jsch/">Jsch</a></li>
|
||
<li><a class="reference external" href="http://jquery.org/">JQuery</a></li>
|
||
<li><a class="reference external" href="http://www.pinlady.net/PluginDetect/">Plugin detect library</a></li>
|
||
<li><a class="reference external" href="http://jqueryui.com/">JQuery UI</a></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
<p>I hope to do nor forget anythinh here, if i do, please, report it so we can credit
|
||
to every project that UDS makes use of.</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="intro/overview.html" title="UDS at a glance"
|
||
>next</a> |</li>
|
||
<li><a href="#">UDS 1.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer">
|
||
© Copyright 2012, Virtual Cable S.L.U..
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||
</div>
|
||
</body>
|
||
</html> |