Skip to content

Commit b000bde

Browse files
committed
Updated README.md
1 parent ba8e784 commit b000bde

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- [Architecture Diagram](#architecture-diagram)
2121
- [Security](#security)
2222
- [Cache](#cache)
23+
- [Testing](#testing)
2324
- [Installation and Setup](#-installation-and-setup)
2425
- [Configuration](#-configuration)
2526
- [File Properties](#file-properties)
@@ -228,6 +229,10 @@ The library supports transparent result caching via the Spring Cache abstraction
228229
It allows storing the results of Python script executions to avoid repeated computation.
229230
Any Spring-compatible CacheManager can be used, including in-memory, Redis, Caffeine, etc.
230231

232+
### Testing
233+
234+
The library allows testing Python servers using its own Testcontainers GenericContainer implementation.
235+
231236
## 📦 Installation and Setup
232237

233238
### Maven
@@ -266,6 +271,15 @@ If you want to have caching abilities, also add this:
266271
</dependency>
267272
```
268273

274+
If you want to test the work of PythonProcessor instance, add this:
275+
276+
```xml
277+
<dependency>
278+
<groupId>io.github.w4t3rcs</groupId>
279+
<artifactId>spring-boot-python-executor-testcontainers</artifactId>
280+
</dependency>
281+
```
282+
269283
### Gradle
270284

271285
To set up a proper version of the project add this to your `build.gradle`:
@@ -285,6 +299,12 @@ If you want to have caching abilities, also add this:
285299
implementation 'io.github.w4t3rcs:spring-boot-python-executor-cache-starter'
286300
```
287301

302+
If you want to test the work of PythonProcessor instance, add this:
303+
304+
```groovy
305+
implementation 'io.github.w4t3rcs:spring-boot-python-executor-testcontainers'
306+
```
307+
288308
## ⚙️ Configuration
289309

290310
### File Properties
@@ -494,6 +514,8 @@ This environment variable allows you to specify additional Python packages to in
494514

495515
## 💻 Usage Examples
496516

517+
If you want to check out how the library works, you can check `demo-app` module or examples below
518+
497519
### Basic Examples
498520

499521
#### Using Annotations

0 commit comments

Comments
 (0)