Skip to content

Added installation prerequisites for rustup, uv, just, and MSVC #49

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

Open
Hamza1610 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added installation prerequisites for rustup, uv, just, and MSVC #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8c6d4e
Added installation prerequisites for rustup, uv, just, and MSVC
Hamza1610 Aug 10, 2026
6d97540
update README documentation to specify just as optional instruction
Hamza1610 Aug 11, 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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ This repository uses the bdk-ffi repository as a git submodule. Here are useful
1. When initially cloning the repo, the `bdk-ffi` submodule will be empty locally. You can intitiate/populate the directory by using the `just submodule-init` command.
2. If you make local changes to the `bdk-ffi` directory while developing and want to hard delete all changes and return to the exact committed version hash of the bdk-ffi repo, use the `just submodule-reset` command.

## Prerequisites

Before building `bdkpython` locally, ensure you have installed the following tools:

- **Rust toolchain (`rustup`)**: Required to compile `bdk-ffi`. Install from [rustup.rs](https://rustup.rs/).
- **`uv`**: Fast Python package installer and resolver. Install from [Astral uv Docs](https://docs.astral.sh/uv/).
- **`just` (optional)**: Command runner used for repo tasks. Install via `cargo install just` or your system package manager.
- **Windows (C++ Build Tools)**: Install Visual Studio Build Tools with the *Desktop development with C++* workload (provides `link.exe` and MSVC toolchain required for `x86_64-pc-windows-msvc`).

@thunderbiscuit thunderbiscuit Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line I'm less clear on: I thought cargo had those for you by default.

@thunderbiscuit thunderbiscuit Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After looking into this, I propose this line instead:

- **`just`**: Command runner used for repo tasks. Install via `cargo install just` or your system package manager.

_Windows Users_
- **Windows**: Rust's `x86_64-pc-windows-msvc` target needs the MSVC toolchain and Windows SDK. `rustup-init` offers to install these for you; otherwise install Visual Studio Build Tools with the *Desktop development with C++* workload. The build scripts are bash, so run them from Git Bash.

@Hamza1610 Hamza1610 Aug 11, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you are right, the issue was that I personally have to install the just tool using cargo install just which definitely require the MSVC toolchain. I will update it as you suggested, that is better off recommeending installation of the msvc which solve most of the installation issues overhead.
image


## Local Testing and Usage

1. Run one of the build script (skip the submodule update if you are making local changes to the bdk-ffi submodule)
Expand Down
Loading