Final cleanup after constants migration
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 20/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- build-system, documentation
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.
Description
❌ This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.
Overview
With #182–#186 landed, the package should stop shipping le_utils/resources/, and the README should describe the spec workflow instead of keeping Python and JSON in sync by hand.
Complexity: Low
Target branch: main
Context
pyproject.tomlshipsresources/*.jsonthrough[tool.setuptools.package-data].- The README's Constants section says a new constant means editing the Python file and the JSON file; its file formats and format presets sections link to
formatlookup.json(on a personal fork) andpresetlookup.json.
The Change
- The README should say that a constant is added by editing its
spec/file and runningmake build.
Acceptance Criteria
- The built
le-utilswheel contains noresources/files. -
le_utils/resources/contains only thelanguagelookup.jsonsymlink. - README links to
le_utils/resources/point to the matchingspec/files instead, except thelanguagelookup.jsonlink.
AI usage
I made the decisions recorded on #181 and #182; Claude Code applied them to this cleanup against the current code and drafted the issue.
- Dominant language
- Python
- Stars
- 7
- Forks
- 37
- Avg merge
- 7d 42m
- Merged PRs (30d)
- 7
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from learningequality/le-utils
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
learningequality/le-utils#186 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
learningequality/le-utils#185 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
learningequality/le-utils#184 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
learningequality/le-utils#183 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
learningequality/le-utils#182 ·
Maintainers usually reply within 1 day
All issues in learningequality/le-utils
Similar issues
-
Harmony OPeNDAP SubSetter (HOSS) Geographic LARC_CLOUD PREFIRE_SAT2_AUX-SAT R01 production
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
nasa/harmony-autotester#245 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
-
L: github:actions L: php:composer
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
dependabot/dependabot-core#16493 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
DataTalksClub/machine-learning-zoomcamp#730 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 4 days