Author: |
LasLabs, Odoo Community Association (OCA) |
License: |
LGPL-3 |
Branch: |
8.0-issue18616-sftp-hhg |
Repository: |
steingabelgaard/server-tools |
Dependencies: |
base_external_system |
Languages: |
Python (205, 65.9%),
XML (64, 20.6%),
and
reStructuredText (42, 13.5%) |
Other repositories: |
LasLabs/odoo-base,
LasLabs/server-tools,
LiberTang0/odoo-base,
OdooBulgaria/odoo-base-1,
bodi000/odoo-base,
brain-tec/odoo-base,
cedvict/odoo-base,
chiticariu/odoo-base,
forexblog/odoo-base,
francoisdelarbre/odoo-base,
mgielissen/odoo-base,
odoobgorg/LL-odoo-base,
onaconsulting/odoo-base,
sc4you/odoo-base,
sharecodekzc/odoo-base,
and
theadventurecapitalist/odoo-base |
<a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.svg">
</a>
<a name="sftp-connector"></a>
<h2>SFTP Connector</h2>
<p>This module allows you to connect & interact with remote SFTP hosts.</p>
<p>This module does not provide functionality on its own, it is meant to provide
an abstract SFTP core to be utilized by other business logic.</p>
<a name="installation"></a>
<h3>Installation</h3>
<p>To install this module, you need to:</p>
<ul class="simple">
<li>Install paramiko
<code>pip install paramiko</code></li>
</ul>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>SFTP Connectors are configured at the company level, and are available in the
<code>res.company</code> form inside of the <code>SFTP Connectors</code> page.</p>
<a name="usage"></a>
<h3>Usage</h3>
<a name="read-remote-file"></a>
<h4>Read Remote File</h4>
<pre>
<code lang="python"># sftp is a ``connector.sftp`` singleton.
with sftp.open('path/to/remote/file') as file_handler:
data = file_handler.read()</code>
</pre>
<a name="write-remote-file"></a>
<h4>Write Remote File</h4>
<pre>
<code lang="python"># sftp is a ``connector.sftp`` singleton.
with sftp.open('path/to/remote/file', 'w') as file_handler:
file_handler.write('Some data')</code>
</pre>
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/149/10.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="images"></a>
<h4>Images</h4>
<ul class="simple">
<li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Dave Lasley <<a class="reference external" href="mailto:dave@laslabs.com">dave@laslabs.com</a>></li>
</ul>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>