2024-07-31 15:06:45 +00:00
|
|
|
# SSHare
|
|
|
|
|
|
2024-07-31 22:08:18 +00:00
|
|
|
Upload files to a server via ssh
|
2024-07-31 15:06:45 +00:00
|
|
|
|
2024-08-01 06:01:23 +00:00
|
|
|
## Documentation
|
|
|
|
|
|
2024-09-08 22:47:30 +00:00
|
|
|
End User: coming soon...
|
|
|
|
|
Plugin Developer: coming soon...
|
2024-08-01 06:01:23 +00:00
|
|
|
|
2024-09-08 22:47:30 +00:00
|
|
|
## Installing
|
2024-08-01 06:01:23 +00:00
|
|
|
|
2024-09-08 22:47:30 +00:00
|
|
|
SSHare is not available on [PyPI](https://pypi.org)
|
|
|
|
|
To install it you will need to clone the repo and use pip to install it
|
2024-08-01 06:01:23 +00:00
|
|
|
```
|
2024-09-08 22:47:30 +00:00
|
|
|
git clone https://forge.monodon.me/Gnarwhal/sshare.git
|
|
|
|
|
cd sshare
|
|
|
|
|
pip install ./
|
2024-08-01 06:01:23 +00:00
|
|
|
```
|
|
|
|
|
|
2024-09-08 22:47:30 +00:00
|
|
|
By default, the only dependency SSHare has the system's `ssh` (and `scp`) commands
|
|
|
|
|
Beyond that it only utilises the python standard library.
|
2024-08-01 06:01:23 +00:00
|
|
|
|
2024-09-08 22:47:30 +00:00
|
|
|
### Additional Functionality
|
2024-08-01 06:01:23 +00:00
|
|
|
|
2024-09-08 22:47:30 +00:00
|
|
|
The base install is fairly bare bones in terms of functionality.
|
|
|
|
|
Included in the [`examples/`](examples/) submodule, there are included some
|
|
|
|
|
plugins which provide some additional conveniences
|
2024-08-01 06:01:23 +00:00
|
|
|
|
2024-09-08 22:47:30 +00:00
|
|
|
Refer to [coming soon...]() for information on installing plugins
|
