Skip to content

Brandon/bb2 4376 v3 changes #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bwang-icf merged 5 commits into from
Jan 28, 2026
Merged

Brandon/bb2 4376 v3 changes #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
820a143
not working yet v3 changes
bwang-icf Jan 13, 2026
73821b2
removing debug comments
bwang-icf Jan 14, 2026
3e9542c
committing changes needed for local run
bwang-icf Jan 26, 2026
4709feb
removing .whl and adding steps around testing locally
bwang-icf Jan 27, 2026
ee31045
uncommenting install for sdk
bwang-icf Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,6 @@ wheels/

# Installer logs
pip-log.txt
pip-delete-this-directory.txt
pip-delete-this-directory.txt
# Snyk Security Extension - AI Rules (auto-generated)
.github/instructions/snyk_rules.instructions.md
48 changes: 48 additions & 0 deletions README-bb2-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,51 @@ To show the version installed:
docker-compose exec server pip show cms-bluebutton-sdk
```

### Testing Locally

This information is repeated from the SDK (https://github.com/CMSgov/cms-bb2-python-sdk/blob/main/README-sdk-dev.md). It is here for ease of reference as it contains steps relating to the sample client as well.
The current method for seeing the SDK in action is fairly complex, as it requires also setting up the Python sample client (this repo). These both, of course, depend upon the web-server repo for most of their logic. It is possible that in order to fully understand an issue that arises within the SDK or the sample client, a developer would have to track changes across 3 separate projects. There should be some future work to simplify this process as it is very manual and laborious.

The steps listed here are listed elsewhere in the documentation but for the sake of convenience, they are partially repeated here
and written together so that a developer should be able to follow this step by step.

The overall goals are to:

- Build a local version of the SDK
- Run a local version of sample client that consumes a local version of the SDK

### Building a local version of the SDK

Run the following commands in the base of the SDK repository. The commands suppose that you have the Python sample client cloned in the same folder as this SDK repo. Do not be in a virtualenv while running these commands.

```
rm -rf build/
python -m build --wheel --o ../bluebutton-sample-client-python-react/server
```

The --o (or outdir) command should effectively 'copy paste' the built version of the .whl file into where it would be needed for the sample client. If you do not want it in the sample client, omit the --o and file path.

### Run a local version of sample client that consumes a local version of the SDK

Ensure that in bluebutton-sample-client-python-react/server/Dockerfile, uncomment the following line. Replace the version number (1.0.4 in the example) of the .whl file with what has been generated from the previous build command.

```
RUN pip install cms_bluebutton_sdk-1.0.4-py3-none-any.whl
```

In bluebutton-sample-client-python-react/server/Pipfile, add this line:

```
cms-bluebutton-sdk = {file = "./cms_bluebutton_sdk-1.0.4-py3-none-any.whl"}
```

In the base repository of bluebutton-sample-client-python-react, run the following commands. Ensure that you have no currently running containers or images of the sample client.

```
cd server
unzip -l cms_bluebutton_sdk-1.0.4-py3-none-any.whl
pip install cms_bluebutton_sdk-1.0.4-py3-none-any.whl
docker compose up
```

Each time a change is made in the SDK, you must repeat all of the previous steps of building and re-running a local sample client. You must also ensure that the containers and images are removed each time.
2 changes: 2 additions & 0 deletions server/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ RUN if [ "$BUILD_DEVELOPMENT" = "True" ]; then \
pip install cms-bluebutton-sdk; \
fi

# If using a local version of the sdk, copy the wheel file and install it
# RUN pip install cms_bluebutton_sdk-1.0.4-py3-none-any.whl
RUN pipenv lock
RUN pip install click
RUN pipenv install --system --deploy --ignore-pipfile