Adding more friendly user documentation#18
Open
MarcChen wants to merge 13 commits intoJayQueue:mainfrom
Open
Conversation
…nt and environment variable support
…rkflow Feat/toward complete automatic workflow
…tication setup scripts, and restructure documentation.
… securely store them in .env file
Adding more user friendly doc
| data_dir = Path(__file__).parent.parent / "data" / "raw" | ||
| data_dir.mkdir(parents=True, exist_ok=True) | ||
|
|
||
| json_filename = data_dir / f"{activity_name}.json" |
There was a problem hiding this comment.
please handle special characters in activity_name like for example: "z6 30/15' x12". This activity_name will fail with this line.
btw. awsome job with this PR :)
| for activity in new_activities: | ||
| client.downloader.download_activity(activity.id) | ||
| file_name = f"{activity.name}.json" | ||
| input_path = RAW_FIT_FILE_PATH / file_name |
There was a problem hiding this comment.
same issue as in the other comment, file_name with special characters will fail as a path wthout any sanitizing
…are valid for file paths.
feat: filename sanitization
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant improvements to the MyWhoosh2Garmin project, focusing on automation, developer experience, and documentation. It adds a fully automated GitHub Actions workflow for syncing MyWhoosh (via Strava) activities to Garmin Connect, modernizes environment and dependency management, and completely rewrites the documentation for clarity and ease of setup. Additionally, it removes obsolete local automation scripts and configuration files.
Automation & Workflow Integration:
.github/workflows/self-hosted-runner.yml) to automate the full Strava-to-Garmin sync process, including environment setup, dependency installation withuv, and secure usage of secrets for authentication.Developer Experience & Tooling:
.env-templatefile to standardize required environment variables for local development and clarify secret usage..pre-commit-config.yamlwith hooks for code quality (trailing whitespace, JSON/TOML checks, and Python linting/formatting viaruff).Pipfilein favor ofpyproject.tomland theuvpackage manager, simplifying dependency management.Documentation Overhaul:
README.mdto provide a clear, step-by-step overview of the project, its purpose, architecture, setup, environment variables, workflow, and security best practices.SETUP.mdwith detailed instructions for authentication, secret configuration, workflow usage, troubleshooting, and webhook integration for instant sync.Cleanup of Legacy Scripts:
MyWhooshMonitor.ps1PowerShell automation script, as the process is now handled via GitHub Actions.