Skip to content
ColinRobbins edited this page May 30, 2020 · 44 revisions

Swim Club Manager Helper

Welcome the the Swim Club Manager helper application.

Installation

See the instructions for installation on Windows, Linux and Apple.

Configuration

The tool has extensive configuration options, via the file config.yaml created on first used.

Using SCM Helper

If you installed the Windows executable, simply double click for the Windows GUI.

To use the command line tools run scm from a Linux shell, or Windows PowerShell.

For a full list of options, see command line options.

Windows

On Windows, if no options are specified, a GUI will be started. Not all features are available from the GUI.

First use

On first use, a folder scm-helper will be created in the users home directory. This will be populated with a default configuration file.

You will be prompted for the name of your swim club. This is then stored in the config.yaml file. NOTE, if you change this, you will not be able to access backups taken prior to the change.

API Key

First time, you will also be asked for asked for an API key from Swim Club Manager, which can be found in the Setup > Club > Club Details menu.

Password

You will also be asked for a password. This password is used to encrypt the API Key (and also any backups). This should be a unique password for this tool, and not on you use anywhere else (for example to logon to SCM). If you forget this password see recovery options. NOTE - if you forget the password, you will not be able to access backup files.

Exceptions

SCM-Helper can report lots of errors. See the options for handling / ignoring exceptions.

Donations.

The software was developed for free during 2020 lockdown, taking over 100 hours work. If you find the software useful, please consider making a donation to support the NHS Covid 19 appeal.

Issues

Please report issues via the issue page

Author

Contributions

See contributing.

Clone this wiki locally