Summary

This release contains code cleanup by upgrading the project structure to a Poetry project, and refactoring a compute-heavy bottleneck within this program in Rust, drastically improving performance.

Changelog

Added

• taisun - A Python module written in Rust that contains the depth-first search algorithm and associated data structures for structured comments scraping. This library will eventually contain additional code that handles compute-heavy tasks.
• GitHub Actions Workflows
  • rust.yml - Format and lint Rust code.
  • python.yml - Format and test Python code.
  • manual.yml - Build and deploy the mdBook manual to GitHub Pages.
• A new user guide/manual built from mdBook.
• Added type hints to all urs/ code.

Changed

• Dates used in this program have been updated to use the ISO8601 timestamp format (YYYY-MM-DD HH:MM:SS).
• Docstrings have been updated from NumPy to reStructuredText format.
• Simplifying the STYLE_GUIDE.md - The style is dictated by Black and isort for Python code, and rustfmt for Rust.
• Simplifying the README.md
  • Most information previously listed there has been moved to the user guide/manual.
• Formatted every single Python file with Black and isort.
• Upgraded/recorded new demo GIFs.

Deprecated

N/A