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 for future maintainability #58

Open
wants to merge 42 commits into
base: vanilla
Choose a base branch
from
Open

Refactor for future maintainability #58

wants to merge 42 commits into from

Conversation

Teqed
Copy link
Owner

@Teqed Teqed commented Jul 1, 2023

This pull request is part of the work to make it easier for people to read and contribute to FediFetcher.

To achieve this, we needed to:

  • Split find_posts.py into multiple files, as it is currently approaching 1,000 LOC.
  • Enforce code style by Ruff configuration of 'ALL'.
  • Refactor functions to improve reusability and DRY principle.
  • Add additional docstring documentation.
  • Revise variable and function names to improve clarity and adherence to naming conventions.
  • Enhance logging and debugging capabilities by implementing a structured logging framework and adjustable logging levels by configuration file or command line argument.
  • Improve error handling and exception messages.
  • Address warnings from static code analysis tools.
  • Update dependencies to their latest versions.

Todo:

  • Introduce unit tests.
  • Introduce integration tests.
  • Update the project's README with the latest changes and contribution guidelines.
  • Make use of Mastodon.py.
  • Perform benchmarking or profiling to measure the performance.
  • Optimize performance.

image
image

@Teqed Teqed marked this pull request as ready for review July 4, 2023 17:33
@Teqed
Copy link
Owner Author

Teqed commented Jul 4, 2023

image

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.

1 participant