diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 09:48:58 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 09:48:58 +0000 |
| commit | 0a72d268ceccc9fee4a255cea82b8bc180ada716 (patch) | |
| tree | 822d092e24441662f5919d1b8ba3f2421e1997df /python-fs-sshfs.spec | |
| parent | c88ca30148b271feae33d409663eb15d4c98855b (diff) | |
automatic import of python-fs-sshfs
Diffstat (limited to 'python-fs-sshfs.spec')
| -rw-r--r-- | python-fs-sshfs.spec | 552 |
1 files changed, 552 insertions, 0 deletions
diff --git a/python-fs-sshfs.spec b/python-fs-sshfs.spec new file mode 100644 index 0000000..0ee2cf6 --- /dev/null +++ b/python-fs-sshfs.spec @@ -0,0 +1,552 @@ +%global _empty_manifest_terminate_build 0 +Name: python-fs.sshfs +Version: 1.0.1 +Release: 1 +Summary: Pyfilesystem2 over SSH using paramiko +License: LGPLv2+ +URL: https://github.com/althonos/fs.sshfs +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/9d/8a/4ea94bdb4d12229ae118e65c90a1e79116b01970cb021dfc073790855581/fs.sshfs-1.0.1.tar.gz +BuildArch: noarch + +Requires: python3-property-cached +Requires: python3-fs +Requires: python3-paramiko +Requires: python3-six +Requires: python3-setuptools +Requires: python3-configparser + +%description +# `fs.sshfs` [](https://github.com/althonos/fs.sshfs/stargazers) + +[](https://github.com/althonos/fs.sshfs) +[](https://pypi.python.org/pypi/fs.sshfs) +[](https://anaconda.org/conda-forge/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/actions) +[](https://codecov.io/gh/althonos/fs.sshfs) +[](https://www.codacy.com/app/althonos/fs.sshfs/dashboard) +[](https://choosealicense.com/licenses/lgpl-2.1/) +[](https://pypi.org/project/fs.sshfs) +[](https://pypi.org/project/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/issues) +[](https://pepy.tech/project/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/blob/master/CHANGELOG.md) + + +## Requirements + +| **PyFilesystem2** | [](https://pypi.python.org/pypi/fs) | [](https://github.com/PyFilesystem/pyfilesystem2) | [](https://choosealicense.com/licenses/mit/) | +|:-|:-|:-|:-| +| **six** | [](https://pypi.python.org/pypi/six) | []( https://github.com/benjaminp/six) | [](https://choosealicense.com/licenses/mit/) | +| **paramiko** | [](https://pypi.python.org/pypi/paramiko) | []( https://github.com/paramiko/paramiko) | [](https://choosealicense.com/licenses/lgpl-2.1/) | +| **property-cached** | [](https://pypi.python.org/pypi/property-cached) | [](https://github.com/althonos/property-cached) | []( https://choosealicense.com/licenses/bsd-3-clause/) | + +`fs.sshfs` supports all Python versions supported by PyFilesystem2: +Python 2.7, and Python 3.5 onwards. Code should still be compatible with +Python 3.4, but not tested anymore. + + +## Installation + +Install directly from PyPI, using [pip](https://pip.pypa.io/): + +```console +$ pip install fs.sshfs +``` + +There is also a [`conda-forge` package](https://conda-forge.org/) available: + +```console +$ conda install -c conda-forge fs.sshfs +``` + + +## Usage + +### Opener + +Use `fs.open_fs` to open a filesystem with an SSH +[FS URL](https://docs.pyfilesystem.org/en/latest/openers.html): + +```python +import fs +my_fs = fs.open_fs("ssh://[user[:password]@]host[:port]/[directory]") +``` + +The `sftp` scheme can be used as an alias for the `ssh` scheme in the FS +URL. Additional argument can be passed to the `SSHFS` constructor as +percent-encoded URL parameters (excepted `policy`). See section below +for a list of all supported arguments. + +### Constructor + +For a more granular way of connecting to an SSH server, use the +`fs.sshfs.SSHFS` constructor, which signature is: + +```python +from fs.sshfs import SSHFS +my_fs = SSHFS( + host, user=None, passwd=None, pkey=None, timeout=10, port=22, + keepalive=10, compress=False, config_path='~/.ssh/config' +) +``` + +with each argument explained below: + +- `host`: the name or IP address of the SSH server +- `user`: the username to connect with, defaults to the current user. +- `passwd`: an optional password, used to connect directly to the server or + to decrypt the public key, if any given. +- `pkey`: a [`paramiko.PKey`](http://docs.paramiko.org/en/stable/api/keys.html#paramiko.pkey.PKey) + object, a path, or a list of paths to an SSH key. +- `timeout`: the timeout, in seconds, for networking operations. +- `port`: the port the SSH server is listening on. +- `keepalive`: the interval of time between *keepalive* packets, in seconds. + Set to 0 to disable. +- `compress`: set to `True` to compress the communications with the server. +- `config_path`: the path to an OpenSSH configuration file. +- `exec_timeout`: the timeout, in seconds, for arbitrary SSH commands on + the server. +- `policy`: a + [`paramiko.MissingHostKeyPolicy`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.MissingHostKeyPolicy) + instance, or `None` to use + [`paramiko.AutoAddPolicy`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.AutoAddPolicy). + +Additional keyword arguments will be passed to the underlying +[`paramiko.SSHClient.connect`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.SSHClient.connect) +call, taking precedence over implicitly derived arguments. Once created, the `SSHFS` filesystem behaves like any +other filesystem (see the [PyFilesystem2 documentation](https://pyfilesystem2.readthedocs.io)). + +### Files + +`SSHFS.openbin` has the following extra options that can be passed as +keyword arguments to control the file buffering: + +- `prefetch`: enabled by default, use a background thread to prefetch the content + of a file opened in reading mode. Does nothing for files in writing mode. +- `pipelined`: enable pipelined mode, avoid waiting for server answer between + two uploaded chunks. Does nothing for files in reading mode. + + +## Configuration + +`SSHFS` are aware of [SSH config +files](http://nerderati.com/2011/03/17/simplify-your-life-with-an-ssh-config-file/) +and as such, one of the hosts in the configuration file can be provided +as the `host` argument for the filesystem to connect to the server with +the proper configuration values. + + +## Feedback + +Found a bug ? Have an enhancement request ? Head over to the [GitHub +issue tracker](https://github.com/althonos/fs.sshfs/issues) of the +project if you need to report or ask something. If you are filling in on +a bug, please include as much information as you can about the issue, +and try to recreate the same bug in a simple, easily reproductible +situation. + + +## Credits + +`fs.sshfs` is developped and maintainted by: +- [Martin Larralde](https://github.com/althonos) + +The following people contributed to `fs.sshfs`: +- [Reimar Bauer](https://github.com/ReimarBauer) +- [Paul Gessinger](https://github.com/paulgessinger) +- [Mariusz Kryński](https://github.com/mrk-its) +- [Will McGugan](https://github.com/willmcgugan) +- [Jeremy Nimmer](https://github.com/jwnimmer-tri) +- [Tim Nyborg](https://github.com/timnyborg) +- [Danica J. Sutherland](https://github.com/djsutherland) +- [John Vandenberg](https://github.com/jayvdb) + +This project obviously owes a lot to the PyFilesystem2 project and +[all its contributors](https://github.com/PyFilesystem/pyfilesystem2/blob/master/CONTRIBUTORS.md). + +## See also + +- [fs](https://github.com/Pyfilesystem/pyfilesystem2), the core + PyFilesystem2 library +- [fs.archive](https://github.com/althonos/fs.archive), enhanced + archive filesystems for PyFilesystem2 +- [fs.smbfs](https://github.com/althonos/fs.smbfs), PyFilesystem2 over + SMB using pysmb + + + + +%package -n python3-fs.sshfs +Summary: Pyfilesystem2 over SSH using paramiko +Provides: python-fs.sshfs +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-fs.sshfs +# `fs.sshfs` [](https://github.com/althonos/fs.sshfs/stargazers) + +[](https://github.com/althonos/fs.sshfs) +[](https://pypi.python.org/pypi/fs.sshfs) +[](https://anaconda.org/conda-forge/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/actions) +[](https://codecov.io/gh/althonos/fs.sshfs) +[](https://www.codacy.com/app/althonos/fs.sshfs/dashboard) +[](https://choosealicense.com/licenses/lgpl-2.1/) +[](https://pypi.org/project/fs.sshfs) +[](https://pypi.org/project/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/issues) +[](https://pepy.tech/project/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/blob/master/CHANGELOG.md) + + +## Requirements + +| **PyFilesystem2** | [](https://pypi.python.org/pypi/fs) | [](https://github.com/PyFilesystem/pyfilesystem2) | [](https://choosealicense.com/licenses/mit/) | +|:-|:-|:-|:-| +| **six** | [](https://pypi.python.org/pypi/six) | []( https://github.com/benjaminp/six) | [](https://choosealicense.com/licenses/mit/) | +| **paramiko** | [](https://pypi.python.org/pypi/paramiko) | []( https://github.com/paramiko/paramiko) | [](https://choosealicense.com/licenses/lgpl-2.1/) | +| **property-cached** | [](https://pypi.python.org/pypi/property-cached) | [](https://github.com/althonos/property-cached) | []( https://choosealicense.com/licenses/bsd-3-clause/) | + +`fs.sshfs` supports all Python versions supported by PyFilesystem2: +Python 2.7, and Python 3.5 onwards. Code should still be compatible with +Python 3.4, but not tested anymore. + + +## Installation + +Install directly from PyPI, using [pip](https://pip.pypa.io/): + +```console +$ pip install fs.sshfs +``` + +There is also a [`conda-forge` package](https://conda-forge.org/) available: + +```console +$ conda install -c conda-forge fs.sshfs +``` + + +## Usage + +### Opener + +Use `fs.open_fs` to open a filesystem with an SSH +[FS URL](https://docs.pyfilesystem.org/en/latest/openers.html): + +```python +import fs +my_fs = fs.open_fs("ssh://[user[:password]@]host[:port]/[directory]") +``` + +The `sftp` scheme can be used as an alias for the `ssh` scheme in the FS +URL. Additional argument can be passed to the `SSHFS` constructor as +percent-encoded URL parameters (excepted `policy`). See section below +for a list of all supported arguments. + +### Constructor + +For a more granular way of connecting to an SSH server, use the +`fs.sshfs.SSHFS` constructor, which signature is: + +```python +from fs.sshfs import SSHFS +my_fs = SSHFS( + host, user=None, passwd=None, pkey=None, timeout=10, port=22, + keepalive=10, compress=False, config_path='~/.ssh/config' +) +``` + +with each argument explained below: + +- `host`: the name or IP address of the SSH server +- `user`: the username to connect with, defaults to the current user. +- `passwd`: an optional password, used to connect directly to the server or + to decrypt the public key, if any given. +- `pkey`: a [`paramiko.PKey`](http://docs.paramiko.org/en/stable/api/keys.html#paramiko.pkey.PKey) + object, a path, or a list of paths to an SSH key. +- `timeout`: the timeout, in seconds, for networking operations. +- `port`: the port the SSH server is listening on. +- `keepalive`: the interval of time between *keepalive* packets, in seconds. + Set to 0 to disable. +- `compress`: set to `True` to compress the communications with the server. +- `config_path`: the path to an OpenSSH configuration file. +- `exec_timeout`: the timeout, in seconds, for arbitrary SSH commands on + the server. +- `policy`: a + [`paramiko.MissingHostKeyPolicy`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.MissingHostKeyPolicy) + instance, or `None` to use + [`paramiko.AutoAddPolicy`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.AutoAddPolicy). + +Additional keyword arguments will be passed to the underlying +[`paramiko.SSHClient.connect`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.SSHClient.connect) +call, taking precedence over implicitly derived arguments. Once created, the `SSHFS` filesystem behaves like any +other filesystem (see the [PyFilesystem2 documentation](https://pyfilesystem2.readthedocs.io)). + +### Files + +`SSHFS.openbin` has the following extra options that can be passed as +keyword arguments to control the file buffering: + +- `prefetch`: enabled by default, use a background thread to prefetch the content + of a file opened in reading mode. Does nothing for files in writing mode. +- `pipelined`: enable pipelined mode, avoid waiting for server answer between + two uploaded chunks. Does nothing for files in reading mode. + + +## Configuration + +`SSHFS` are aware of [SSH config +files](http://nerderati.com/2011/03/17/simplify-your-life-with-an-ssh-config-file/) +and as such, one of the hosts in the configuration file can be provided +as the `host` argument for the filesystem to connect to the server with +the proper configuration values. + + +## Feedback + +Found a bug ? Have an enhancement request ? Head over to the [GitHub +issue tracker](https://github.com/althonos/fs.sshfs/issues) of the +project if you need to report or ask something. If you are filling in on +a bug, please include as much information as you can about the issue, +and try to recreate the same bug in a simple, easily reproductible +situation. + + +## Credits + +`fs.sshfs` is developped and maintainted by: +- [Martin Larralde](https://github.com/althonos) + +The following people contributed to `fs.sshfs`: +- [Reimar Bauer](https://github.com/ReimarBauer) +- [Paul Gessinger](https://github.com/paulgessinger) +- [Mariusz Kryński](https://github.com/mrk-its) +- [Will McGugan](https://github.com/willmcgugan) +- [Jeremy Nimmer](https://github.com/jwnimmer-tri) +- [Tim Nyborg](https://github.com/timnyborg) +- [Danica J. Sutherland](https://github.com/djsutherland) +- [John Vandenberg](https://github.com/jayvdb) + +This project obviously owes a lot to the PyFilesystem2 project and +[all its contributors](https://github.com/PyFilesystem/pyfilesystem2/blob/master/CONTRIBUTORS.md). + +## See also + +- [fs](https://github.com/Pyfilesystem/pyfilesystem2), the core + PyFilesystem2 library +- [fs.archive](https://github.com/althonos/fs.archive), enhanced + archive filesystems for PyFilesystem2 +- [fs.smbfs](https://github.com/althonos/fs.smbfs), PyFilesystem2 over + SMB using pysmb + + + + +%package help +Summary: Development documents and examples for fs.sshfs +Provides: python3-fs.sshfs-doc +%description help +# `fs.sshfs` [](https://github.com/althonos/fs.sshfs/stargazers) + +[](https://github.com/althonos/fs.sshfs) +[](https://pypi.python.org/pypi/fs.sshfs) +[](https://anaconda.org/conda-forge/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/actions) +[](https://codecov.io/gh/althonos/fs.sshfs) +[](https://www.codacy.com/app/althonos/fs.sshfs/dashboard) +[](https://choosealicense.com/licenses/lgpl-2.1/) +[](https://pypi.org/project/fs.sshfs) +[](https://pypi.org/project/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/issues) +[](https://pepy.tech/project/fs.sshfs) +[](https://github.com/althonos/fs.sshfs/blob/master/CHANGELOG.md) + + +## Requirements + +| **PyFilesystem2** | [](https://pypi.python.org/pypi/fs) | [](https://github.com/PyFilesystem/pyfilesystem2) | [](https://choosealicense.com/licenses/mit/) | +|:-|:-|:-|:-| +| **six** | [](https://pypi.python.org/pypi/six) | []( https://github.com/benjaminp/six) | [](https://choosealicense.com/licenses/mit/) | +| **paramiko** | [](https://pypi.python.org/pypi/paramiko) | []( https://github.com/paramiko/paramiko) | [](https://choosealicense.com/licenses/lgpl-2.1/) | +| **property-cached** | [](https://pypi.python.org/pypi/property-cached) | [](https://github.com/althonos/property-cached) | []( https://choosealicense.com/licenses/bsd-3-clause/) | + +`fs.sshfs` supports all Python versions supported by PyFilesystem2: +Python 2.7, and Python 3.5 onwards. Code should still be compatible with +Python 3.4, but not tested anymore. + + +## Installation + +Install directly from PyPI, using [pip](https://pip.pypa.io/): + +```console +$ pip install fs.sshfs +``` + +There is also a [`conda-forge` package](https://conda-forge.org/) available: + +```console +$ conda install -c conda-forge fs.sshfs +``` + + +## Usage + +### Opener + +Use `fs.open_fs` to open a filesystem with an SSH +[FS URL](https://docs.pyfilesystem.org/en/latest/openers.html): + +```python +import fs +my_fs = fs.open_fs("ssh://[user[:password]@]host[:port]/[directory]") +``` + +The `sftp` scheme can be used as an alias for the `ssh` scheme in the FS +URL. Additional argument can be passed to the `SSHFS` constructor as +percent-encoded URL parameters (excepted `policy`). See section below +for a list of all supported arguments. + +### Constructor + +For a more granular way of connecting to an SSH server, use the +`fs.sshfs.SSHFS` constructor, which signature is: + +```python +from fs.sshfs import SSHFS +my_fs = SSHFS( + host, user=None, passwd=None, pkey=None, timeout=10, port=22, + keepalive=10, compress=False, config_path='~/.ssh/config' +) +``` + +with each argument explained below: + +- `host`: the name or IP address of the SSH server +- `user`: the username to connect with, defaults to the current user. +- `passwd`: an optional password, used to connect directly to the server or + to decrypt the public key, if any given. +- `pkey`: a [`paramiko.PKey`](http://docs.paramiko.org/en/stable/api/keys.html#paramiko.pkey.PKey) + object, a path, or a list of paths to an SSH key. +- `timeout`: the timeout, in seconds, for networking operations. +- `port`: the port the SSH server is listening on. +- `keepalive`: the interval of time between *keepalive* packets, in seconds. + Set to 0 to disable. +- `compress`: set to `True` to compress the communications with the server. +- `config_path`: the path to an OpenSSH configuration file. +- `exec_timeout`: the timeout, in seconds, for arbitrary SSH commands on + the server. +- `policy`: a + [`paramiko.MissingHostKeyPolicy`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.MissingHostKeyPolicy) + instance, or `None` to use + [`paramiko.AutoAddPolicy`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.AutoAddPolicy). + +Additional keyword arguments will be passed to the underlying +[`paramiko.SSHClient.connect`](http://docs.paramiko.org/en/stable/api/client.html#paramiko.client.SSHClient.connect) +call, taking precedence over implicitly derived arguments. Once created, the `SSHFS` filesystem behaves like any +other filesystem (see the [PyFilesystem2 documentation](https://pyfilesystem2.readthedocs.io)). + +### Files + +`SSHFS.openbin` has the following extra options that can be passed as +keyword arguments to control the file buffering: + +- `prefetch`: enabled by default, use a background thread to prefetch the content + of a file opened in reading mode. Does nothing for files in writing mode. +- `pipelined`: enable pipelined mode, avoid waiting for server answer between + two uploaded chunks. Does nothing for files in reading mode. + + +## Configuration + +`SSHFS` are aware of [SSH config +files](http://nerderati.com/2011/03/17/simplify-your-life-with-an-ssh-config-file/) +and as such, one of the hosts in the configuration file can be provided +as the `host` argument for the filesystem to connect to the server with +the proper configuration values. + + +## Feedback + +Found a bug ? Have an enhancement request ? Head over to the [GitHub +issue tracker](https://github.com/althonos/fs.sshfs/issues) of the +project if you need to report or ask something. If you are filling in on +a bug, please include as much information as you can about the issue, +and try to recreate the same bug in a simple, easily reproductible +situation. + + +## Credits + +`fs.sshfs` is developped and maintainted by: +- [Martin Larralde](https://github.com/althonos) + +The following people contributed to `fs.sshfs`: +- [Reimar Bauer](https://github.com/ReimarBauer) +- [Paul Gessinger](https://github.com/paulgessinger) +- [Mariusz Kryński](https://github.com/mrk-its) +- [Will McGugan](https://github.com/willmcgugan) +- [Jeremy Nimmer](https://github.com/jwnimmer-tri) +- [Tim Nyborg](https://github.com/timnyborg) +- [Danica J. Sutherland](https://github.com/djsutherland) +- [John Vandenberg](https://github.com/jayvdb) + +This project obviously owes a lot to the PyFilesystem2 project and +[all its contributors](https://github.com/PyFilesystem/pyfilesystem2/blob/master/CONTRIBUTORS.md). + +## See also + +- [fs](https://github.com/Pyfilesystem/pyfilesystem2), the core + PyFilesystem2 library +- [fs.archive](https://github.com/althonos/fs.archive), enhanced + archive filesystems for PyFilesystem2 +- [fs.smbfs](https://github.com/althonos/fs.smbfs), PyFilesystem2 over + SMB using pysmb + + + + +%prep +%autosetup -n fs.sshfs-1.0.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-fs.sshfs -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.1-1 +- Package Spec generated |