Update configuration management to use confy for file-based configuration. #98

Closed
opened 2024-05-06 08:13:01 +02:00 by PatrykHegenberg · 1 comment
PatrykHegenberg commented 2024-05-06 08:13:01 +02:00 (Migrated from github.com)

Summary
Update the program to read configuration from a file using confy instead of reading environment variables with dotenv.

Description
Currently, the program reads configuration from environment variables using dotenv. To improve flexibility and ease of configuration, it's proposed to switch to reading configuration from a file using the confy crate. This change will allow users to define configurations in a separate file, enhancing readability and maintainability.

Acceptance Criteria
Which criteria has to be reached to be accepted

  • Update the program to use confy for configuration management.
  • Ensure that the program reads configuration values correctly from the specified file.
  • Maintain compatibility with existing functionality.
  • Ensure clear documentation is provided for configuring the program using confy.

Tasks
Which tasks are included to add this feature

  • Integrate confy crate into the project.
  • Implement logic to load configuration from a file using confy.
  • Update documentation to reflect changes in configuration setup.

Dependencies
Which dependencies are introduced to the project

  • Add confy crate as a dependency.

Estimates
Estimated effort for completion: 2 hours

Additional Information
Switching to confy for configuration management will enhance the flexibility and maintainability of the program, making it easier for users to manage configurations. This change aligns with best practices for Rust programming and improves the overall user experience.

**Summary** Update the program to read configuration from a file using confy instead of reading environment variables with dotenv. **Description** Currently, the program reads configuration from environment variables using dotenv. To improve flexibility and ease of configuration, it's proposed to switch to reading configuration from a file using the confy crate. This change will allow users to define configurations in a separate file, enhancing readability and maintainability. **Acceptance Criteria** Which criteria has to be reached to be accepted - [x] Update the program to use confy for configuration management. - [x] Ensure that the program reads configuration values correctly from the specified file. - [x] Maintain compatibility with existing functionality. - [ ] Ensure clear documentation is provided for configuring the program using confy. **Tasks** Which tasks are included to add this feature - [x] Integrate confy crate into the project. - [x] Implement logic to load configuration from a file using confy. - [ ] Update documentation to reflect changes in configuration setup. **Dependencies** Which dependencies are introduced to the project - [x] Add confy crate as a dependency. **Estimates** Estimated effort for completion: 2 hours **Additional Information** Switching to confy for configuration management will enhance the flexibility and maintainability of the program, making it easier for users to manage configurations. This change aligns with best practices for Rust programming and improves the overall user experience.
PatrykHegenberg commented 2024-05-09 16:06:57 +02:00 (Migrated from github.com)

Except for the documentation, all subtasks of the issue have been completed. As the project documentation has its own milestone, I would classify this task as completed.

Except for the documentation, all subtasks of the issue have been completed. As the project documentation has its own milestone, I would classify this task as completed.
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: git/caesar-transfer#98
No description provided.