jschalk / jaar

Cross-cultural communication engine built on customizable economic systems. Produces personalized agendas, calendars, finance reports for users.
0 stars 1 forks source link

175 enable documentation process #297

Closed jschalk closed 1 month ago

jschalk commented 1 month ago

Summary by Sourcery

Refactor the codebase to replace hardcoded strings with string constants, add new functions for CSV processing, introduce new stone format JSON files, and update tests accordingly. Remove deprecated 'range_push' functionality.

Enhancements:

Tests:

Chores:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements significant changes to the project structure, focusing on refactoring and enhancing the stone format system, updating various data models, and improving code organization. The changes include the addition of new stone format files, modifications to existing files, and the removal of deprecated functionality.

File-Level Changes

Change Details Files
Refactored and enhanced the stone format system
  • Added new stone format files (e.g., stone_format_00019_ideaunit_v0_0_0.json)
  • Updated existing stone format related functions and classes
  • Removed deprecated jaar_format functions and replaced with stone_format
src/stone/stone.py
src/stone/formatbuilder.py
src/stone/stone_formats/*.json
Updated data models and removed deprecated functionality
  • Removed range_push related functions and attributes
  • Added gogo_want and stop_want attributes to IdeaUnit
  • Updated BudUnit and related classes to reflect these changes
src/bud/idea.py
src/bud/bud.py
src/normal_db/normal_models.py
Improved code organization and standardization
  • Moved some functions from stone/csv_tool.py to _instrument/python_tool.py
  • Standardized the use of string constants (e.g., acct_id_str(), owner_id_str())
  • Updated import statements and function calls to reflect these changes
src/_instrument/python_tool.py
src/gift/atom_config.py
src/gift/legible.py
src/gift/change.py
Enhanced chrono functionality
  • Added support for multiple timelines (e.g., creg and cinco)
  • Updated chrono-related functions and tests
src/chrono/chrono.py
src/chrono/examples/chrono_examples.py
src/chrono/test/test_chrono_config.py

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](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.