Skip to content
This repository was archived by the owner on Dec 5, 2025. It is now read-only.

Commit ada4b25

Browse files
authored
[doc] Update local development howto (#149)
1 parent 6eb47cf commit ada4b25

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,27 @@ $ pip3 install pycti
2121
## Local development
2222

2323
```bash
24-
$ pip3 install . --user --force --upgrade
24+
# Fork the current repository, then clone your fork
25+
$ git clone https://github.com/YOUR-USERNAME/client-python
26+
$ cd client-python
27+
$ git remote add upstream https://github.com/OpenCTI-Platform/client-python.git
28+
# Create a branch for your feature/fix
29+
$ git checkout -b [branch-name]
30+
# Create a virtualenv
31+
$ python3 -m venv .venv
32+
$ source .venv/bin/activate
33+
# Install the client-python and dependencies for the development and the documentation
34+
$ python3 -m pip install -e .[dev,doc]
35+
# Set up the git hook scripts
36+
$ pre-commit install
37+
# Create your feature/fix
38+
# Create tests for your changes
39+
$ pytest
40+
# Push you feature/fix on Github
41+
$ git add [file(s)]
42+
$ git commit -m "[descriptive message]"
43+
$ git push origin [branch-name]
44+
# Open a pull request
2545
```
2646

2747
## Documentation

0 commit comments

Comments
 (0)