Skip to content

Commit 2d84aa0

Browse files
committed
2 parents 8eeec58 + 82e66ba commit 2d84aa0

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# PythonSTL - Python Standard Template Library
22

3+
[![Downloads](https://img.shields.io/pypi/dw/pythonstl.svg)](https://pypi.org/project/pythonstl/)
34
[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
45
[![PyPI version](https://img.shields.io/pypi/v/pythonstl.svg)](https://pypi.org/project/pythonstl/)
56
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
6-
[![Version](https://img.shields.io/badge/version-0.1.1-brightgreen.svg)](https://github.com/AnshMNSoni/STL)
7+
[![Version](https://img.shields.io/badge/version-0.1.1-brightgreen.svg)](https://github.com/AnshMNSoni/PythonSTL)
78

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+
<div align="center">
10+
<img width="500" height="500" alt="pythonstl_logo" src="https://github.com/user-attachments/assets/7ef83b5f-d005-48e0-a186-05dd7e2221c2" />
11+
</div><br>
12+
13+
A 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.
914

1015
## Features
1116

@@ -28,8 +33,8 @@ pip install pythonstl
2833
Or install from source:
2934

3035
```bash
31-
git clone https://github.com/AnshMNSoni/STL.git
32-
cd STL
36+
git clone https://github.com/AnshMNSoni/PythonSTL.git
37+
cd PythonSTL
3338
pip install -e .
3439
```
3540

@@ -355,8 +360,8 @@ pytest tests/ --cov=pythonstl --cov-report=html
355360
### Setup
356361

357362
```bash
358-
git clone https://github.com/AnshMNSoni/STL.git
359-
cd STL
363+
git clone https://github.com/AnshMNSoni/PythonSTL.git
364+
cd PythonSTL
360365
pip install -e ".[dev]"
361366
```
362367

@@ -373,6 +378,10 @@ flake8 pythonstl/
373378
pytest && mypy pythonstl/ && flake8 pythonstl/
374379
```
375380

381+
## Note
382+
➡️ The goal is NOT to replace Python built-ins.<br>
383+
➡️ The goal is to provide: 1) Conceptual clarity 2) STL familiarity for C++ developers 3) A structured learning bridge for DSA <br>
384+
376385
## 📝 License
377386

378387
MIT License - see LICENSE file for details.
@@ -386,9 +395,10 @@ Contributions are welcome! Please:
386395
4. Ensure all tests pass
387396
5. Submit a pull request
388397

398+
## Thankyou
389399
## Contact
390400

391401
- GitHub: [@AnshMNSoni](https://github.com/AnshMNSoni)
392-
- Issues: [GitHub Issues](https://github.com/AnshMNSoni/STL/issues)
402+
- Issues: [GitHub Issues](https://github.com/AnshMNSoni/PythonSTL/issues)
393403

394404
**PythonSTL v0.1.1** - Bringing C++ STL elegance to Python

0 commit comments

Comments
 (0)