Document process for vendors to publish wheels that can get consumed by robotpy installer

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the existing wpilib documentation page containing the table of Python package names, then review the linked cross-ubuntu-py/pip-aarch64.conf for the installer context. Add the vendor publishing guidance to an appropriate documentation page, including the linux_roborio.whl naming requirement, PyPI simulation wheels, and package-name listing; done means the process is published and discoverable.

Written by the indexing model from the issue text.

Description

I wrote this, needs to be added to a page somewhere:

The robotpy installer pulls roborio wheels from the wpilib artifactory repo (see https://github.com/wpilibsuite/docker-images/blob/main/cross-ubuntu-py/pip-aarch64.conf ... Peter can set you up with a token). The wheels have to end in linux_roborio.whl.

Just publish your x86 wheels to pypi like normal python project and the robotpy installer will pull those for simulation.

Additionally, you'll want to publish the package name in the wpilib docs, there's a table with python package names.

Dominant language
Python
Stars
10
Forks
25
No merged PRs in 30d

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.

More from robotpy/robotpy-docs

All issues in robotpy/robotpy-docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.