adafruit / adafruit/circup

Install the PYPI version of library locally when installing CP version

Open
#140 1 comment 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
Python
Stars
172
Forks
41
Avg merge
1d 20h
Merged PRs (30d)
1

Description

**Proposed option to the install command**
`circup install adafruit_ble_broadcastnet --pypi`

**Proposed Behavior**

This is only for install command only:
- If `--pypi` option is specified, also `pip3 install {pypi_name}` the library as specified in the bundle.json
- If No pypi library is available, report a warning, but complete all other actions

**Notes**

I was playing around with the autocomplete\stubs functionality in VSCode's Pylance, and if you pip install the CPython version of a CP package, VS Code will pickup that up and and not give a reportMissingImports error.

Also required:
1. Install Python Extension (which includes Pylance)
2. Set python.analysis.stubPath to site packages for your python environment. ex for Pyenv in a cp_base virtualenv on MacOS: `/Users/username/.pyenv/versions/cp_base/lib/python3.9/site-packages/`

Update learn guide if implemented [Welcome To CP](https://learn.adafruit.com/welcome-to-circuitpython/pycharm-and-circuitpython)

- I bet the PyCharm information can be updated
- Add a VS Code section

Contributor guide

Open the contributing guide

Research direction

Start with the install command and the bundle.json metadata described in the issue, then review the linked Welcome To CP guide and its PyCharm information. Done means the install-only --pypi option installs an available PyPI package, warns without failing when none exists, and the guide includes the requested VS Code section.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, vscode
Domain
cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.