Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor codebase and adopt common conventions of open source Python projects #167

Conversation

soaressgabriel
Copy link
Collaborator

@soaressgabriel soaressgabriel commented Mar 10, 2024

Checklist

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Added tests for changed code.
  • Updated documentation for changed code.

Description

  • Removed "TODO" markers from the codebase;
  • Removed unnecessary variable declarations;
  • Reorganized model definition class methods;
  • Renamed variables, methods and functions using snake_case and meaningful names;
  • Renamed classes using meaningful names;
  • Added typehints where absent;
  • Formatted source code files;
  • Reimplemented tss2csv and removed Pandas dependency;
  • Simplified source code where possible;
  • Removed unused source code and its respective tests (when they existed);
  • Removed unused test data;
  • Updated test data and their respective integration tests;
  • Added raster and CSV file equality utility functions for integration tests;

Related Issue

Motivation and context

How has this been tested

  • Manual testing was performed by executing RUBEM with provided sample dataset and verifying the output against expected results;
  • Automated tests (unit and integration), including CLI integration tests added in this branch, must pass without exception.

Screenshots

  • N/A

@soaressgabriel soaressgabriel self-assigned this Mar 10, 2024
@soaressgabriel soaressgabriel changed the title Refactor codebase and adopt common conventions of open source python projects Refactor codebase and adopt common conventions of open source Python projects Mar 10, 2024
@soaressgabriel soaressgabriel marked this pull request as draft March 12, 2024 12:31
@soaressgabriel soaressgabriel marked this pull request as ready for review March 12, 2024 18:29
Copy link
Collaborator

@LINAMARIAOSORIO LINAMARIAOSORIO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@soaressgabriel soaressgabriel merged commit 76f9f74 into main Mar 12, 2024
4 checks passed
@soaressgabriel soaressgabriel deleted the refactor/116-refactor-codebase-and-adopt-common-conventions-of-open-source-python-projects branch March 12, 2024 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove Pandas dependency Refactor codebase and adopt common conventions of open source Python projects
2 participants