Refactoring

[brunopacheco1]

Summary by Sourcery

Refactor code for improved clarity and update documentation to reflect current project setup and guidelines. Enhance CI workflow with code style checks and migrate Docker base image to UBI 9.

Enhancements:

• Refactor exception messages in rems.py for clarity and consistency.
• Update default URLs for CKAN and REMS in main.py to new development environment URLs.

Documentation:

• Revise README.md to include updated project description, installation instructions, and usage guidelines.
• Update CONTRIBUTING.md with detailed steps for setting up the development environment and contributing to the project.

Tests:

• Add a step in the GitHub Actions test workflow to check Python code style using Black.

Chores:

• Migrate base Docker image to UBI 9 as noted in the CHANGELOG.md.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements several refactoring changes across multiple files. The main changes include updating the README.md with more specific project information, improving the CONTRIBUTING.md guidelines, fixing typos and error messages in the REMS synchronizer code, updating environment variables, adding code formatting checks, and introducing a Docker Compose file for easier deployment.

File-Level Changes

Files	Changes
README.md	Updated README.md with more specific project information, including installation instructions and license details
CONTRIBUTING.md	Improved CONTRIBUTING.md with more detailed setup instructions and coding guidelines
src/rems.py	Fixed typos and improved error messages in REMS synchronizer code
src/main.py	Updated environment variables and added error logging in the main script
dev-requirements.txt	Added Black code formatter as a development requirement
.github/workflows/test.yml	Added Black code formatting check to the test workflow
CHANGELOG.md	Updated CHANGELOG.md with new changes
compose.yaml	Added a Docker Compose file for easier deployment

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @brunopacheco1 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider updating the CHANGELOG.md more comprehensively to reflect all the changes made in this refactoring effort.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 3 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sonarqubecloud]

Quality Gate passed

Issues
4 New issues
2 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud