learningequality / learningequality/le-utils

Final cleanup after constants migration

Open
#187 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7
Forks
36
PR merge metrics
No merged PRs in 30d

Description

This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.

Overview

Final cleanup tasks after all 5 module migrations are complete. This issue removes the legacy resources/ directory and updates configuration files.

Prerequisites

Blocked by: #182, #183, #184, #185, #186

All 5 module migrations must be completed before this cleanup can proceed.

Tasks
  1. Remove package_data from setup.py

    • Remove the line: package_data={"le_utils": ["resources/*.json"]}
    • The resources directory will no longer exist, so this must be removed
  2. Delete le_utils/resources/ directory

    • Verify all JSON files have been deleted by individual migration issues
    • Remove the empty resources/ directory itself
  3. Update README.md

    • Remove warnings about keeping Python/JSON in sync
    • Update documentation to describe spec + generation workflow
    • Remove references to manual constants maintenance
  4. Update CHANGELOG.md

    • Add entry for the migration with version number
    • List all migrated modules
    • Note JavaScript exports now available for all constants
  5. Verify entire test suite passes

    • Run pytest tests/ -v
    • Ensure no broken imports or references to old JSON files
How to Verify
# Ensure resources directory doesn't exist
ls le_utils/resources/  # should error: No such file or directory

# Verify tests pass
pytest tests/ -v

# Verify build works
make build

# Verify package can be installed
python setup.py sdist
pip install dist/le-utils-*.tar.gz
Acceptance Criteria
  • package_data removed from setup.py
  • le_utils/resources/ directory deleted
  • README.md updated to remove sync warnings
  • README.md updated to document spec + generation workflow
  • CHANGELOG.md updated with migration notes
  • All tests pass: pytest tests/ -v
  • make build succeeds
  • Package builds and installs successfully

Disclosure

🤖 This issue was written by Claude Code, under supervision, review and final edits by @rtibbles 🤖

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

After issues #182–#186 are complete, inspect package_data in setup.py and verify the le_utils/resources/ directory is gone. Update README.md and CHANGELOG.md as specified, then run pytest tests/ -v, make build, and the package build/install commands; done means all listed acceptance criteria pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.