Skip to content

Commit

Permalink
build based on 3006a9d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 9, 2023
1 parent 273bb07 commit 9920007
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>SFTPClient.jl Documentation · Julia SFTPClient Documentation </title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Julia SFTPClient Documentation </a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>SFTPClient.jl Documentation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>SFTPClient.jl Documentation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>SFTPClient.jl Documentation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/stensmo/SFTPClient.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="SFTPClient.jl-Documentation"><a class="docs-heading-anchor" href="#SFTPClient.jl-Documentation">SFTPClient.jl Documentation</a><a id="SFTPClient.jl-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#SFTPClient.jl-Documentation" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.cd-Tuple{SFTP, AbstractString}" href="#Base.Filesystem.cd-Tuple{SFTP, AbstractString}"><code>Base.Filesystem.cd</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">cd(sftp::SFTP, dir::AbstractString)

Change the directory for the SFTP client.</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L364-L369">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.mkdir-Tuple{SFTP, AbstractString}" href="#Base.Filesystem.mkdir-Tuple{SFTP, AbstractString}"><code>Base.Filesystem.mkdir</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">mkdir(sftp::SFTP, dir::AbstractString)
Change the directory for the SFTP client.</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L364-L369">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.mkdir-Tuple{SFTP, AbstractString}" href="#Base.Filesystem.mkdir-Tuple{SFTP, AbstractString}"><code>Base.Filesystem.mkdir</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">mkdir(sftp::SFTP, dir::AbstractString)

Create a directory</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L416-L422">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.mv-Tuple{SFTP, AbstractString, AbstractString}" href="#Base.Filesystem.mv-Tuple{SFTP, AbstractString, AbstractString}"><code>Base.Filesystem.mv</code></a> — <span class="docstring-category">Method</span></header><section><div><p>mv( sftp::SFTP, old<em>name::AbstractString, new</em>name::AbstractString; )</p><p>Move, i.e., rename the file. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L428-L437">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.readdir" href="#Base.Filesystem.readdir"><code>Base.Filesystem.readdir</code></a> — <span class="docstring-category">Function</span></header><section><div><p>readdir(sftp::SFTP, join::Bool = false, sort::Bool = true)</p><p>Reads the current directory. Returns a vector of Strings just like the regular readdir function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L319-L324">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.rm-Tuple{SFTP, AbstractString}" href="#Base.Filesystem.rm-Tuple{SFTP, AbstractString}"><code>Base.Filesystem.rm</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rm(sftp::SFTP, file_name::AbstractString)
Create a directory</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L416-L422">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.mv-Tuple{SFTP, AbstractString, AbstractString}" href="#Base.Filesystem.mv-Tuple{SFTP, AbstractString, AbstractString}"><code>Base.Filesystem.mv</code></a> — <span class="docstring-category">Method</span></header><section><div><p>mv( sftp::SFTP, old<em>name::AbstractString, new</em>name::AbstractString; )</p><p>Move, i.e., rename the file. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L428-L437">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.readdir" href="#Base.Filesystem.readdir"><code>Base.Filesystem.readdir</code></a> — <span class="docstring-category">Function</span></header><section><div><p>readdir(sftp::SFTP, join::Bool = false, sort::Bool = true)</p><p>Reads the current directory. Returns a vector of Strings just like the regular readdir function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L319-L324">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.Filesystem.rm-Tuple{SFTP, AbstractString}" href="#Base.Filesystem.rm-Tuple{SFTP, AbstractString}"><code>Base.Filesystem.rm</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rm(sftp::SFTP, file_name::AbstractString)

Remove (delete) the file</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L395-L400">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.download" href="#SFTPClient.download"><code>SFTPClient.download</code></a> — <span class="docstring-category">Function</span></header><section><div><p>SFTP.download( sftp::SFTP, file_name::AbstractString, output = tempname();downloadDir::Union{String, Nothing}=nothing)</p><pre><code class="nohighlight hljs"> Download a file. You can download it and use it directly, or save it to a file.
Remove (delete) the file</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L395-L400">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.download" href="#SFTPClient.download"><code>SFTPClient.download</code></a> — <span class="docstring-category">Function</span></header><section><div><p>SFTP.download( sftp::SFTP, file_name::AbstractString, output = tempname();downloadDir::Union{String, Nothing}=nothing)</p><pre><code class="nohighlight hljs"> Download a file. You can download it and use it directly, or save it to a file.
Specify downloadDir if you want to save downloaded files. You can also use broadcasting.
Example:

Expand All @@ -15,6 +15,6 @@
SFTPClient.download.(sftp, files, downloadDir=downloadDir)

You can also use it like this:
df=DataFrame(CSV.File(SFTPClient.download(sftp, &quot;/mydir/test.csv&quot;)))</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L262-L282">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.rmdir-Tuple{SFTP, AbstractString}" href="#SFTPClient.rmdir-Tuple{SFTP, AbstractString}"><code>SFTPClient.rmdir</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rmdir(sftp::SFTP, dir_name::AbstractString)
df=DataFrame(CSV.File(SFTPClient.download(sftp, &quot;/mydir/test.csv&quot;)))</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L262-L282">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.rmdir-Tuple{SFTP, AbstractString}" href="#SFTPClient.rmdir-Tuple{SFTP, AbstractString}"><code>SFTPClient.rmdir</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rmdir(sftp::SFTP, dir_name::AbstractString)

Remove (delete) the directory</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L406-L410">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.upload-Tuple{SFTP, AbstractString}" href="#SFTPClient.upload-Tuple{SFTP, AbstractString}"><code>SFTPClient.upload</code></a> — <span class="docstring-category">Method</span></header><section><div><p>upload(sftp::SFTP, file_name::AbstractString)</p><p>Upload (put) a file to the server. Broadcasting can be used too. </p><p>files=readdir() upload.(sftp,files)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L234-L242">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.SFTP-Tuple{AbstractString, AbstractString, AbstractString}" href="#SFTPClient.SFTP-Tuple{AbstractString, AbstractString, AbstractString}"><code>SFTPClient.SFTP</code></a> — <span class="docstring-category">Method</span></header><section><div><p>function SFTP(url::AbstractString, username::AbstractString, password::AbstractString;create<em>known</em>hosts<em>entry=true, disable</em>verify<em>peer=false, disable</em>verify_host=false)</p><p>Creates a new SFTP Client: url: The url to connect to, e.g., sftp://mysite.com username: The username to use password: The users password create<em>known</em>hosts_entry: Automatically create an entry in known hosts</p><p>Example: sftp = SFTP(&quot;sftp://test.rebex.net&quot;, &quot;demo&quot;, &quot;password&quot;)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L119-L133">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.SFTP-Tuple{AbstractString, AbstractString}" href="#SFTPClient.SFTP-Tuple{AbstractString, AbstractString}"><code>SFTPClient.SFTP</code></a> — <span class="docstring-category">Method</span></header><section><div><p>function SFTP(url::AbstractString, username::AbstractString;disable<em>verify</em>peer=false, disable<em>verify</em>host=false)</p><p>Creates a new SFTP client using certificate authentication. Provide the username in the url</p><p>sftp = SFTP(&quot;sftp://mysitewhereIhaveACertificate.com&quot;, &quot;myuser&quot;)</p><p>Note! You must provide the username for this to work. </p><p>Before using this method, you must set up your certificates in ~/.ssh/id<em>rsa and ~/.ssh/id</em>rsa.pub</p><p>Of course, the server need to be in the known_hosts file as well. </p><p>Test using your local client first: ssh myuser@mysitewhereIhaveACertificate.com</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3ed1663fbca59b6416e999ed4e51391342562f06/src/SFTPImpl.jl#L90-L105">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 9 September 2023 20:03">Saturday 9 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Remove (delete) the directory</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L406-L410">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.upload-Tuple{SFTP, AbstractString}" href="#SFTPClient.upload-Tuple{SFTP, AbstractString}"><code>SFTPClient.upload</code></a> — <span class="docstring-category">Method</span></header><section><div><p>upload(sftp::SFTP, file_name::AbstractString)</p><p>Upload (put) a file to the server. Broadcasting can be used too. </p><p>files=readdir() upload.(sftp,files)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L234-L242">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.SFTP-Tuple{AbstractString, AbstractString, AbstractString}" href="#SFTPClient.SFTP-Tuple{AbstractString, AbstractString, AbstractString}"><code>SFTPClient.SFTP</code></a> — <span class="docstring-category">Method</span></header><section><div><p>function SFTP(url::AbstractString, username::AbstractString, password::AbstractString;create<em>known</em>hosts<em>entry=true, disable</em>verify<em>peer=false, disable</em>verify_host=false)</p><p>Creates a new SFTP Client: url: The url to connect to, e.g., sftp://mysite.com username: The username to use password: The users password create<em>known</em>hosts_entry: Automatically create an entry in known hosts</p><p>Example: sftp = SFTP(&quot;sftp://test.rebex.net&quot;, &quot;demo&quot;, &quot;password&quot;)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L119-L133">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SFTPClient.SFTP-Tuple{AbstractString, AbstractString}" href="#SFTPClient.SFTP-Tuple{AbstractString, AbstractString}"><code>SFTPClient.SFTP</code></a> — <span class="docstring-category">Method</span></header><section><div><p>function SFTP(url::AbstractString, username::AbstractString;disable<em>verify</em>peer=false, disable<em>verify</em>host=false)</p><p>Creates a new SFTP client using certificate authentication. Provide the username in the url</p><p>sftp = SFTP(&quot;sftp://mysitewhereIhaveACertificate.com&quot;, &quot;myuser&quot;)</p><p>Note! You must provide the username for this to work. </p><p>Before using this method, you must set up your certificates in ~/.ssh/id<em>rsa and ~/.ssh/id</em>rsa.pub</p><p>Of course, the server need to be in the known_hosts file as well. </p><p>Test using your local client first: ssh myuser@mysitewhereIhaveACertificate.com</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/stensmo/SFTPClient.jl/blob/3006a9d33e3fec7a42d002825fd7b733a93966db/src/SFTPImpl.jl#L90-L105">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 9 September 2023 20:06">Saturday 9 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 9920007

Please sign in to comment.