openworm / openworm/c302

Update documentation and code to run c302/c302_*.py as python -m c302.c302_*

Open
#8 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement good first issue
Dominant language
Python
Stars
156
Forks
37
PR merge metrics
No merged PRs in 30d

Description

Relative imports break in possibly unexpected ways when you run a script from inside of its package directory rather than let python do it for you with -m

Contributor guide

No contributing guide indexed for this repository

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

Start by inspecting the c302/c302_.py scripts and the documentation that describes how they are run, then review their relative imports. Update the documented invocation and code as needed so each script works with python -m c302.c302_. Done means the module-based commands run successfully from outside the package directory.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.