You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/project-contributions.md
+20-15Lines changed: 20 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,29 +2,34 @@
2
2
3
3
The information in this page is primarily for those who wish to contribute to the c2pa-python library project itself, rather than those who simply wish to use it in an application. For general contribution guidelines, see [CONTRIBUTING.md](../CONTRIBUTING.md).
4
4
5
-
## Development Setup
5
+
## Setup
6
6
7
7
It is best to [set up a virtual environment](https://virtualenv.pypa.io/en/latest/installation.html) for development and testing:
8
8
9
9
```bash
10
10
# Create virtual environment
11
11
python -m venv .venv
12
-
13
-
# Activate virtual environment
14
-
# On Windows:
15
-
.venv\Scripts\activate
16
-
# On macOS/Linux:
17
-
source .venv/bin/activate
18
12
```
19
13
14
+
Activate the virtual environment.
15
+
16
+
- On Windows:
17
+
```bash
18
+
.venv\Scripts\activate
19
+
```
20
+
- On macOS/Linux:
21
+
```bash
22
+
source .venv/bin/activate
23
+
```
24
+
20
25
Load project dependencies:
21
26
22
27
```bash
23
28
pip install -r requirements.txt
24
29
pip install -r requirements-dev.txt
25
30
```
26
31
27
-
Download library artifacts for the current version you want, eg v0.55.0:
32
+
Download library artifacts for the current version you want, (for example, as shown below forv0.55.0):
28
33
29
34
```bash
30
35
python scripts/download_artifacts.py c2pa-v0.55.0
@@ -36,10 +41,10 @@ Install the package in development mode:
36
41
pip install -e .
37
42
```
38
43
39
-
This will:
44
+
This command:
40
45
41
-
-Copy the appropriate libraries for your platform from `artifacts/` to `src/c2pa/libs/`
42
-
-Install the package in development mode, allowing you to make changes to the Python code without reinstalling.
46
+
- Copies the appropriate libraries for your platform from `artifacts/` to `src/c2pa/libs/`
47
+
- Installs the package in development mode, so you can make changes to the Python code without reinstalling.
43
48
44
49
## Build from source
45
50
@@ -130,10 +135,10 @@ Run tests by following these steps:
130
135
make test
131
136
```
132
137
5. Alternatively, install pytest (if not already installed) and run it:
0 commit comments