Skip to content

Commit 293c3e5

Browse files
committed
Update contriguting doc
Add small info about install all packages in local development env
1 parent a183273 commit 293c3e5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ This repository is organized as a monorepo, containing multiple packages that ar
3535
- **Autogenerated Packages**: These can be found in the `./versions` directory. This section contains components or packages that are automatically generated. The generation process is typically based on predefined specifications or templates and may be updated frequently to reflect changes in those specifications.
3636

3737
This structure helps in maintaining a clear separation between manually edited and automatically generated code, facilitating better management and development workflows within the repository.
38+
## Manual Installation of Python Packages
39+
40+
To manually install the necessary Python packages in editable mode, you can use the pip install -e command. This is useful for development purposes, as it allows you to make changes to the package source code and have those changes immediately reflected without the need to reinstall the package. Follow these steps to install the specified packages:
41+
```bash
42+
pip install -e ./packages/catalystwan-types \
43+
-e ./packages/catalystwan-core \
44+
-e ./versions/catalystwan-v20_15 \
45+
-e ./versions/catalystwan-v20_16
46+
```
47+
By following these instructions, you will have the packages installed in an editable manner, allowing for easy development and testing.
3848

3949
## Running Tests
4050

0 commit comments

Comments
 (0)