piezza/garminexport
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix error in documentation about export_formats argument type.

Browse Source
This commit is contained in:
Stanislav Khrapov 2018-06-29 21:16:38 +02:00 committed by Peter Gardfjäll
parent 73c1559ba5
commit e0474057dd
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
garminexport/incremental_backup.py
View File

@ -3,6 +3,7 @@ import getpass
import logging import logging
import os import os
from datetime import timedelta from datetime import timedelta
from typing import List
import garminexport.backup import garminexport.backup
from garminexport.backup import supported_export_formats from garminexport.backup import supported_export_formats
@ -15,7 +16,7 @@ log = logging.getLogger(__name__)
def incremental_backup(username: str, def incremental_backup(username: str,
password: str = None, password: str = None,
backup_dir: str = os.path.join(".", "activities"), backup_dir: str = os.path.join(".", "activities"),
export_formats: str = 'ALL', export_formats: List[str] = None,
ignore_errors: bool = False, ignore_errors: bool = False,
max_retries: int = 7): max_retries: int = 7):
"""Performs (incremental) backups of activities for a given Garmin Connect account. """Performs (incremental) backups of activities for a given Garmin Connect account.
@ -23,7 +24,8 @@ def incremental_backup(username: str,
:param username: Garmin Connect user name :param username: Garmin Connect user name
:param password: Garmin Connect user password. Default: None. If not provided, would be asked interactively. :param password: Garmin Connect user password. Default: None. If not provided, would be asked interactively.
:param backup_dir: Destination directory for downloaded activities. Default: ./activities/". :param backup_dir: Destination directory for downloaded activities. Default: ./activities/".
:param export_formats: Desired output formats (json_summary, json_details, gpx, tcx, fit). Default: ALL. :param export_formats: List of desired output formats (json_summary, json_details, gpx, tcx, fit).
Default: `None` which means all supported formats will be backed up.
:param ignore_errors: Ignore errors and keep going. Default: False. :param ignore_errors: Ignore errors and keep going. Default: False.
:param max_retries: The maximum number of retries to make on failed attempts to fetch an activity. :param max_retries: The maximum number of retries to make on failed attempts to fetch an activity.
Exponential backoff will be used, meaning that the delay between successive attempts Exponential backoff will be used, meaning that the delay between successive attempts