Skip to content

Latest commit

 

History

History
135 lines (98 loc) · 6.04 KB

TUTORIAL.md

File metadata and controls

135 lines (98 loc) · 6.04 KB

Tutorial

First Steps

When you open the app for the first time you will see the minimal example. Try to run it by pressing the "Run All" button.

init

The setting dialog should pop up, where you can enter the save path (the save path is the folder where everything gets stored).

init settings

Try to run the minimal example again. Now it should work.

right

If you want you can now open the folder at the save path, either by manuel opening it via the explorer/finder, or by right clicking the "Minimal Example" item and then clicking "Open Folder".

open folder1

Inside the "Polybox" folder should now be a hello_word.txt

You could have opened the hello_word.txt also directly via the application by selecting the Polybox item and clicking the "Folder" button at the bottom.

open folder2

You should now see the content of the Polybox folder. You can open the hello_word.txt file by double clicking it.

Adding your own Websites

You can add your own websites by clicking on the "Edit" button

12

and then double-clicking on the "Add Site" item.

add1

In this tutorial we will add another shared polybox folder.
We want to add this link: https://polybox.ethz.ch/index.php/s/UFfLsy8gX84eLw1

3

Type in the ID. You can also name the folder with the "Folder Name" field. (If the "Folder Name" field is empty, it will try to guess a name.) Then press the OK button.

The items support drag'n drop, so they can be rearranged.

ezgif-7-18824102d4c6

Note: It's also possible to delete items by selecting them and pressing the delete button.

Note: Right clicking an item will show the edit and delete option.

Now you can save the template and run it again

Unbenannt

Note: The old Polybox folder from the previous run is still there, this is because the application never deletes files.

For are more detailed explanation of every available website, and their settings click here

Also, if you are in luck there might be already a preset template for your department and semester at the menu bar File->Open Presets->...

Note: The preset templates don't store any passwords, that means you have to replace every "INSERT PASSWORD" with the correct password.

preset

Command Line Interface (CLI)

The CLI is only useful if you want to automate the application. For example, you could run the application on a server and sync the folder with your pc.

To be able to run the CLI you need to be running from source (See the README).

To see all the possible arguments run python main.py --help.

usage: main.py [-h] [--app-data-path APP_DATA_PATH]
               [--loglevel {ERROR,WARNING,INFO,DEBUG}]
               [--check_for_updates | --no-check_for_updates]
               [--template_path TEMPLATE_PATH] [--username USERNAME]
               [--password PASSWORD] [--save_path SAVE_PATH]
               [--allowed_extensions [ALLOWED_EXTENSIONS [ALLOWED_EXTENSIONS ...]]]
               [--forbidden_extensions [FORBIDDEN_EXTENSIONS [FORBIDDEN_EXTENSIONS ...]]]
               [--keep_replaced_files | --no-keep_replaced_files]
               [--highlight_difference | --no-highlight_difference]
               [--highlight_page_limit HIGHLIGHT_PAGE_LIMIT]
               [--force_download | --no-force_download]
               [--conn_limit CONN_LIMIT]
               [--conn_limit_per_host CONN_LIMIT_PER_HOST]
               [--theme {Native,Fusion Dark,Fusion Light}]

optional arguments:
  -h, --help            show this help message and exit
  --app-data-path APP_DATA_PATH
  --loglevel {ERROR,WARNING,INFO,DEBUG}
  --check_for_updates
  --no-check_for_updates
  --template_path TEMPLATE_PATH
  --username USERNAME
  --password PASSWORD
  --save_path SAVE_PATH
  --allowed_extensions [ALLOWED_EXTENSIONS [ALLOWED_EXTENSIONS ...]]
  --forbidden_extensions [FORBIDDEN_EXTENSIONS [FORBIDDEN_EXTENSIONS ...]]
  --keep_replaced_files
  --no-keep_replaced_files
  --highlight_difference
  --no-highlight_difference
  --highlight_page_limit HIGHLIGHT_PAGE_LIMIT
  --force_download
  --no-force_download
  --conn_limit CONN_LIMIT
  --conn_limit_per_host CONN_LIMIT_PER_HOST
  --theme {Native,Fusion Dark,Fusion Light}

Note: You can control the location of the settings/cache files with the app-data-path argument

Every argument is optional. The reason behind this is, that it will try to read the values first from the setting file, which is generated by the GUI. If a required value is neither in the settings or the arguments, you will get an error. So it's possible, that everything works on your local pc, but not on your server. We recommend setting each relevant argument.

Note: Some arguments are only for the GUI application and have no effect on the CLI version.