<!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>AutoInstallPluginManager — Yapsy 1.10.2 documentation</title>
<link rel="stylesheet" href="_static/default.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.10.2',
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>
<link rel="shortcut icon" href="_static/yapsy-favicon.ico"/>
<link rel="top" title="Yapsy 1.10.2 documentation" href="index.html" />
<link rel="up" title="Built-in Extensions" href="Extensions.html" />
<link rel="next" title="FilteredPluginManager" href="FilteredPluginManager.html" />
<link rel="prev" title="ConfigurablePluginManager" href="ConfigurablePluginManager.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="FilteredPluginManager.html" title="FilteredPluginManager"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ConfigurablePluginManager.html" title="ConfigurablePluginManager"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Yapsy 1.10.2 documentation</a> »</li>
<li><a href="Extensions.html" accesskey="U">Built-in Extensions</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-yapsy.AutoInstallPluginManager">
<span id="autoinstallpluginmanager"></span><h1>AutoInstallPluginManager<a class="headerlink" href="#module-yapsy.AutoInstallPluginManager" title="Permalink to this headline">¶</a></h1>
<div class="section" id="role">
<h2>Role<a class="headerlink" href="#role" title="Permalink to this headline">¶</a></h2>
<p>Defines plugin managers that can handle the installation of plugin
files into the right place. Then the end-user does not have to browse
to the plugin directory to install them.</p>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="yapsy.AutoInstallPluginManager.AutoInstallPluginManager">
<em class="property">class </em><tt class="descclassname">yapsy.AutoInstallPluginManager.</tt><tt class="descname">AutoInstallPluginManager</tt><big>(</big><em>plugin_install_dir=None</em>, <em>decorated_manager=None</em>, <em>categories_filter={'Default': <class 'yapsy.IPlugin.IPlugin'>}</em>, <em>directories_list=None</em>, <em>plugin_info_ext='yapsy-plugin'</em><big>)</big><a class="headerlink" href="#yapsy.AutoInstallPluginManager.AutoInstallPluginManager" title="Permalink to this definition">¶</a></dt>
<dd><p>A plugin manager that also manages the installation of the plugin
files into the appropriate directory.</p>
<dl class="method">
<dt id="yapsy.AutoInstallPluginManager.AutoInstallPluginManager.getInstallDir">
<tt class="descname">getInstallDir</tt><big>(</big><big>)</big><a class="headerlink" href="#yapsy.AutoInstallPluginManager.AutoInstallPluginManager.getInstallDir" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the directory where new plugins should be installed.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.AutoInstallPluginManager.AutoInstallPluginManager.install">
<tt class="descname">install</tt><big>(</big><em>directory</em>, <em>plugin_info_filename</em><big>)</big><a class="headerlink" href="#yapsy.AutoInstallPluginManager.AutoInstallPluginManager.install" title="Permalink to this definition">¶</a></dt>
<dd><p>Giving the plugin’s info file (e.g. <tt class="docutils literal"><span class="pre">myplugin.yapsy-plugin</span></tt>),
and the directory where it is located, get all the files that
define the plugin and copy them into the correct directory.</p>
<p>Return <tt class="docutils literal"><span class="pre">True</span></tt> if the installation is a success, <tt class="docutils literal"><span class="pre">False</span></tt> if
it is a failure.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.AutoInstallPluginManager.AutoInstallPluginManager.installFromZIP">
<tt class="descname">installFromZIP</tt><big>(</big><em>plugin_ZIP_filename</em><big>)</big><a class="headerlink" href="#yapsy.AutoInstallPluginManager.AutoInstallPluginManager.installFromZIP" title="Permalink to this definition">¶</a></dt>
<dd><p>Giving the plugin’s zip file (e.g. <tt class="docutils literal"><span class="pre">myplugin.zip</span></tt>), check
that their is a valid info file in it and correct all the
plugin files into the correct directory.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Only available for python 2.6 and later.</p>
</div>
<p>Return <tt class="docutils literal"><span class="pre">True</span></tt> if the installation is a success, <tt class="docutils literal"><span class="pre">False</span></tt> if
it is a failure.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.AutoInstallPluginManager.AutoInstallPluginManager.setInstallDir">
<tt class="descname">setInstallDir</tt><big>(</big><em>plugin_install_dir</em><big>)</big><a class="headerlink" href="#yapsy.AutoInstallPluginManager.AutoInstallPluginManager.setInstallDir" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the directory where to install new plugins.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/yapsy-big.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">AutoInstallPluginManager</a><ul>
<li><a class="reference internal" href="#role">Role</a></li>
<li><a class="reference internal" href="#api">API</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="ConfigurablePluginManager.html"
title="previous chapter">ConfigurablePluginManager</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="FilteredPluginManager.html"
title="next chapter">FilteredPluginManager</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/AutoInstallPluginManager.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="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="FilteredPluginManager.html" title="FilteredPluginManager"
>next</a> |</li>
<li class="right" >
<a href="ConfigurablePluginManager.html" title="ConfigurablePluginManager"
>previous</a> |</li>
<li><a href="index.html">Yapsy 1.10.2 documentation</a> »</li>
<li><a href="Extensions.html" >Built-in Extensions</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2013, Thibauld Nion.
Last updated on Oct 05, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
