-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome the the Swim Club Manager helper application.
See the instructions for installation on Windows, Linux and Apple.
The tool has extensive configuration options, via the file config.yaml
created on first used.
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.
On Windows, if no options are specified, a GUI will be started. Not all features are available from the GUI.
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.
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.
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.
SCM-Helper can report lots of errors. See the options for handling / ignoring exceptions.
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.
Please report issues via the issue page
See contributing.