Skip to content

Commit ef89483

Browse files
committed
Tania review feedbacK
1 parent 2aa1527 commit ef89483

File tree

1 file changed

+7
-36
lines changed

1 file changed

+7
-36
lines changed

docs/project-contributions.md

Lines changed: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ The information in this page is primarily for those who wish to contribute to th
77
It is best to [set up a virtual environment](https://virtualenv.pypa.io/en/latest/installation.html) for development and testing:
88

99
```bash
10-
# Create virtual environment
1110
python -m venv .venv
1211
```
1312

@@ -46,32 +45,7 @@ This command:
4645
- Copies the appropriate libraries for your platform from `artifacts/` to `src/c2pa/libs/`
4746
- Installs the package in development mode, so you can make changes to the Python code without reinstalling.
4847

49-
## Build from source
50-
51-
To build from source on Linux, install `curl` and `rustup` then set up Python.
52-
53-
First update `apt` then (if needed) install `curl`:
54-
55-
```bash
56-
apt update
57-
apt install curl
58-
```
59-
60-
Install Rust:
61-
62-
```bash
63-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
64-
source "$HOME/.cargo/env"
65-
```
66-
67-
Install Python, `pip`, and `venv`:
68-
69-
```bash
70-
apt install python3
71-
apt install pip
72-
apt install python3.11-venv
73-
python3 -m venv .venv
74-
```
48+
## Building wheels
7549

7650
Build the wheel for your platform (from the root of the repository):
7751

@@ -84,22 +58,18 @@ pip install -U pytest
8458
python3 -m build --wheel
8559
```
8660

87-
## Building wheels
88-
89-
To build wheels for all platforms that have libraries in the `artifacts/` directory:
61+
To test local wheels locally, enter this command:
9062

9163
```bash
92-
python setup.py bdist_wheel
64+
make test-local-wheel-build
9365
```
9466

95-
You can use `twine` to verify the wheels have correct metadata:
67+
To verify the builds, enter this command:
9668

9769
```bash
98-
twine check dist/*
70+
make verify-wheel-build
9971
```
10072

101-
This will create platform-specific wheels in the `dist/` directory.
102-
10373
## Project structure
10474

10575
```bash
@@ -134,11 +104,12 @@ Run tests by following these steps:
134104
```bash
135105
make test
136106
```
137-
5. Alternatively, install pytest (if not already installed) and run it:
107+
5. Alternatively, install `pytest` (if not already installed) and run it:
138108
```bash
139109
pip install pytest
140110
pytest
141111
```
112+
**Warning**: `pytest` often has issues when switching between virtual environments.
142113

143114
### Testing during bindings development
144115

0 commit comments

Comments
 (0)