Skip to content

Commit

Permalink
Merge pull request #5 from jat255/update_readme
Browse files Browse the repository at this point in the history
Update readme with assistance from @chrisf4lc0n
  • Loading branch information
jat255 authored Mar 12, 2023
2 parents cca6317 + d0df63a commit 4e9335b
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,22 @@ You'll need the following:
- You'll need to use your "Client ID" and "Client Secret" from this page
- [Poetry](https://python-poetry.org/) installed on the system where this
tool will run
- A Python installation version 3.9 or higher. Installing this will depend
on your specific system, but I highly recommend using
[`pyenv`](https://github.com/pyenv/pyenv), which will allow you to install
any version of Python you'd like and choose between them as needed. Assuming
you have at least one 3.9 or higher version installed with `pyenv`, Poetry is
smart enough to pick up that and use the correct Python version when installing
`strava-to-fittrackee`.
- If you prefer to use system packages, on recent versions of Ubuntu you should
be able to run `sudo apt install python3.9`. If using the system package, you'll
probably also need to run `poetry env use 3.9` to configure poetry to use that
specific version.
- If using `pyenv`, running `$ pyenv install 3.9.16` or `$ pyenv install 3.10.10`
should get you a version that will work with `s2f.py`. In this case, Poetry should
be clever enough to analyze the versions of Python you have installed and pick the
correct one (although you can also run that `poetry env use` command to specify a
particular one)

## Installation

Expand Down Expand Up @@ -194,13 +210,18 @@ activities.

The script can be scheduled using a tool such as `cron`, or the Windows task scheduler
to run at one ore more set times each day. A line such as the following will run
the script at 9AM, 12PM, 3PM, 6PM, and 9PM every day, logging to a file named `s2f.log`
in the home directory of `user`:
the script twice per hour every day, logging to a file named `s2f.log`
in the home directory of `user`. This example assumes you installed Poetry to its
default location (run `$ which poetry` to find the correct executable location if
yours is different):

```
0 9,12,15,18,21 * * * cd /home/user/s2f && /home/user/.local/bin/poetry run python s2f.py --sync -v 2 >> /home/user/s2f.log 2>&1
5,35 * * * * cd /home/user/s2f && /home/user/.local/bin/poetry run python s2f.py --sync -v 2 >> /home/user/s2f.log 2>&1
```

By changing to the `s2f` directory and running the script via `$ poetry run python s2f.py`,
Poetry should automatically determine the correct Python interpreter to use.

### Bulk downloading from Strava

Although the `--sync` option should work with large numbers of activities (subject to the rate
Expand Down

0 comments on commit 4e9335b

Please sign in to comment.