Refactor: Organize repository and enhance DevOps practices #28
Conversation
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
This commit reorganizes the repository structure for clarity and modularity. It also enhances DevOps practices by: - Setting up GitHub Actions for CI/CD. - Enabling Dependabot for automated dependency updates. - Integrating black for code formatting. - Dockerizing the application for easier deployment and local development. Additionally, documentation has been improved with the addition of CONTRIBUTING.md and CHANGELOG.md.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refines repository structure and code formatting across the project to improve readability and maintainability; it also removes an obsolete SVG asset.
- Removed unused font‐vector SVG file.
- Reformatted tests and source files for consistent trailing commas, line breaks, and indentation.
- Updated models, utils, and reference spec to adhere to the project’s style conventions.
Reviewed Changes
Copilot reviewed 51 out of 72 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| wednesday_font_vector_with_holes.txt | Removed unused SVG asset to declutter repository. |
| tests/test_error_handling.py | Consolidated multi-line arguments and added trailing commas. |
| tests/test_client.py | Inlined parameter lists and standardized commas. |
| src/reference_spec.py | Added spacing and wrapped long lists for clarity. |
| src/parse_openapi.py | Broke complex conditions into multiple lines and added commas. |
| src/oura_api_client/utils/retry.py | Wrapped function signature and calls, added missing commas. |
| src/oura_api_client/utils/query_params.py | Added trailing comma in dict construction. |
| src/oura_api_client/utils/init.py | Standardized export list with trailing comma. |
| src/oura_api_client/models/workout.py | Inlined Literal lists and trimmed blank lines. |
| src/oura_api_client/models/webhook.py | Unified Field declarations into single lines. |
| src/oura_api_client/models/time_series.py | Reformatted Field blocks and validator decorator. |
| src/oura_api_client/models/tag.py | Inline timestamp alias formatting. |
| src/oura_api_client/models/sleep_time.py | Consolidated Field definitions onto fewer lines. |
| src/oura_api_client/models/sleep.py | Wrapped Field definitions consistently. |
| src/oura_api_client/models/session.py | Unified Field declarations and removed extra blank lines. |
| src/oura_api_client/models/ring_configuration.py | Cleaned up Literal definitions and alias formatting. |
| src/oura_api_client/models/rest_mode_period.py | Inlined start/end time fields for readability. |
| src/oura_api_client/models/enhanced_tag.py | Simplified Field alias formatting. |
| src/oura_api_client/models/daily_spo2.py | Streamlined class signature and Field declarations. |
| src/oura_api_client/models/daily_sleep.py | Reformatted properties with consistent parentheses. |
| src/oura_api_client/models/daily_resilience.py | Streamlined resilience Field definitions. |
| src/oura_api_client/models/daily_readiness.py | Inlined Field declarations and removed extra indentation. |
| src/oura_api_client/models/daily_activity.py | Standardized Field declarations in activity models. |
This commit introduces a comprehensive Docker setup for development
and testing, and integrates it into the CI workflow.
Key changes:
- Added a multi-stage Dockerfile:
- Uses python:3.10-slim.
- Creates a non-root user for security.
- Optimizes dependency installation for build caching.
- Copies application code, tests, and configuration.
- Sets 'pytest tests/' as the default command.
- Updated docker-compose.yml:
- Configured for local development with live-reloading volume mounts.
- Default command set to run tests.
- Modified GitHub Actions workflow (.github/workflows/python-app.yml):
- Builds the Docker image.
- Runs linters (flake8) and tests (pytest) inside the Docker container,
ensuring consistency between CI and local development environments.
- Ensured the 'config/' directory is included in the Docker image so
flake8 can access its configuration.
This improved setup provides a consistent, reproducible, and optimized
environment for both local development and CI processes.
Co-authored-by: godely <3101049+godely@users.noreply.github.com>
Co-authored-by: godely <3101049+godely@users.noreply.github.com>
…2-0ed979d16113 Complete branch analysis and cleanup recommendation for ourapy repository
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 commit reorganizes the repository structure for clarity and modularity. It also enhances DevOps practices by:
Additionally, documentation has been improved with the addition of CONTRIBUTING.md and CHANGELOG.md.