Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matias-gonz/file-transfer
File transfer
https://github.com/matias-gonz/file-transfer
7543 fiuba
Last synced: about 5 hours ago
JSON representation
File transfer
- Host: GitHub
- URL: https://github.com/matias-gonz/file-transfer
- Owner: matias-gonz
- Created: 2022-09-14T01:17:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-05T22:19:43.000Z (about 2 years ago)
- Last Synced: 2023-09-30T15:21:24.060Z (about 1 year ago)
- Topics: 7543, fiuba
- Language: Python
- Homepage:
- Size: 93.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# file-transfer
[](https://github.com/matias-gonz/file-transfer/actions/workflows/tests.yml)
[](https://github.com/matias-gonz/file-transfer/actions/workflows/linter.yml)
## Installation
### Dependencies:
* [python3.10^](https://www.python.org/downloads/)
* [Poetry](https://python-poetry.org/docs/#installation)
Once you have installed these tools, make will take care of the rest :relieved:
``` bash
$ make install
```
## Usage
### Start the server
``` bash
$ project_root/src/start-server.py
```
For help using the command, use the option `--help`:
``` bash
$ project_root/src/start-server.py --help
usage: start-server.py [-h] [-v | -q] [-H HOST] [-p PORT] [-s STORAGE] [-o] [-w WINDOW]
Starts file-sharing server
options:
-h, --help show this help message and exit
-v, --verbose increase output verbosity
-q, --quiet decrease output verbosity
-H HOST, --host HOST service IP address
-p PORT, --port PORT service port
-s STORAGE, --storage STORAGE
storage dir path
-o, --one only one transfer
-w WINDOW, --window WINDOW
size of the sending window
```
### Start an upload
``` bash
$ project_root/src/upload.py
```
For help using the command, use the option `--help`:
``` bash
$ project_root/src/upload.py --help
usage: upload.py [-h] [-v | -q] [-H HOST] [-p PORT] [-s SRC] [-n NAME] [-w WINDOW]
Uploads a file to the file-sharing server
options:
-h, --help show this help message and exit
-v, --verbose increase output verbosity
-q, --quiet decrease output verbosity
-H HOST, --host HOST server IP address
-p PORT, --port PORT server port
-s SRC, --src SRC source file path
-n NAME, --name NAME file name
-w WINDOW, --window WINDOW
size of the sending window
```
### Start a download
``` bash
$ project_root/src/download.py
```
For help using the command, use the option `--help`:
``` bash
$ project_root/src/download.py --help
usage: download.py [-h] [-v | -q] [-H HOST] [-p PORT] [-d DST] [-n NAME]
Downloads a file from the file-sharing server
options:
-h, --help show this help message and exit
-v, --verbose increase output verbosity
-q, --quiet decrease output verbosity
-H HOST, --host HOST server IP address
-p PORT, --port PORT server port
-d DST, --dst DST destination file path
-n NAME, --name NAME file name
```
## Run formatters and linter
The repository uses GitHub Workflows to run a linter on each push or pull request.
To run the automatic formatter and linter manually use the following command:
``` bash
$ make lint
```