Add Docs about how to build python libraries
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Problem
If I try running python3 ./application/romi-python/main.py as described in: https://docs.romi-project.eu/Rover/software/ I run into the following error message
python3 main.py
Traceback (most recent call last):
File "~/romi/applications/romi-python/main.py", line 4, in <module>
from romi.rpc import Server
ModuleNotFoundError: No module named 'romi'
so I first of all have to build and install the python library:
cd libromi/python
python3 -m pip install -e .
I think this step should be added to https://docs.romi-project.eu/Rover/software/#starting-up-the-software-manually
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Open the Rover software documentation at https://docs.romi-project.eu/Rover/software/#starting-up-the-software-manually and review the manual startup instructions. Add the documented python3 -m pip install -e . step from libromi/python before running application/romi-python/main.py, then verify the instructions address the reported missing romi module error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100