robotpy / robotpy/robotpy-installer

pip install -e . in robot directory leads to weirdness

Open
#92 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
6
Forks
18
Avg merge
34m
Merged PRs (30d)
1

Description

pip installs it as a package if there's a single file in the directory (if there's more than one python module it fails with a puzzling error). That seems bad, but:

  • I don't think there's much we can do about it other than tell people "don't do that"?
  • Everything else in the python ecosystem seems to be going towards using pyproject.toml, but maybe that's because usually people are developing packages. There are lots of other python tools like black, pytest, etc that tell the user to store settings in pyproject.toml. Open to other alternatives.
$ pip install -e .
Obtaining file:///home/virtuald/tmp
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Preparing editable metadata (pyproject.toml) ... done
Building wheels for collected packages: robot
  Building editable for robot (pyproject.toml) ... done
  Created wheel for robot: filename=robot-0.0.0-0.editable-py3-none-any.whl size=2409 sha256=09ee05001c16b0ef96dc840cf2fdd9c6e935cba772d762ea8a0aef51e9d3a2ce
  Stored in directory: /tmp/pip-ephem-wheel-cache-o4od82hn/wheels/42/47/9c/4dfb4e7b9498c9a1934bfc9254dca0e06686b1a26f6ab4804a
Successfully built robot
Installing collected packages: robot
Successfully installed robot-0.0.0

Reference: https://www.chiefdelphi.com/t/navx-and-robotpy/448996/14

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 reproducing pip install -e . in the robot directory and review the resulting editable package behavior described here. Compare the project’s options with the referenced pyproject.toml practices; done requires a clearly decided approach for preventing or documenting this installation outcome, but the issue does not specify which resolution is preferred.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.