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: README.md
+10-21Lines changed: 10 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
A production-ready Python package that replicates C++ STL-style data structures using the **Facade Design Pattern**. PythonSTL provides clean, familiar interfaces for developers coming from C++ while maintaining Pythonic best practices.
9
9
10
-
## 🎯 Features
10
+
## Features
11
11
12
12
-**C++ STL Compliance**: Exact method names and semantics matching C++ STL
13
13
-**Facade Design Pattern**: Clean separation between interface and implementation
@@ -33,7 +33,7 @@ cd STL
33
33
pip install -e .
34
34
```
35
35
36
-
## 🚀 Quick Start
36
+
## Quick Start
37
37
38
38
```python
39
39
from pythonstl import stack, queue, vector, stl_set, stl_map, priority_queue
-**Maintainability**: Easy to modify internals without breaking API
277
277
-**Testability**: Each layer can be tested independently
278
278
279
-
## 🔒 Thread Safety
279
+
## Thread Safety
280
280
281
281
**Important:** PythonSTL containers are **NOT thread-safe** by default. If you need to use them in a multi-threaded environment, you must provide your own synchronization (e.g., using `threading.Lock`).
282
282
@@ -292,7 +292,7 @@ def thread_safe_push(value):
292
292
s.push(value)
293
293
```
294
294
295
-
## 🎨 Design Decisions
295
+
## Design Decisions
296
296
297
297
### Why Facade Pattern?
298
298
@@ -315,7 +315,7 @@ Full Python integration while maintaining STL compatibility:
315
315
- Copy protocol support
316
316
- Maintains backward compatibility
317
317
318
-
## 📊 Benchmarks
318
+
## Benchmarks
319
319
320
320
PythonSTL provides benchmarks comparing performance against Python built-ins:
321
321
@@ -335,7 +335,7 @@ The facade pattern adds minimal overhead while providing:
335
335
336
336
See `benchmarks/README.md` for detailed analysis.
337
337
338
-
## 🧪 Testing
338
+
## Testing
339
339
340
340
Run the test suite:
341
341
@@ -386,20 +386,9 @@ Contributions are welcome! Please:
0 commit comments