Skip to content

Commit 4154931

Browse files
authored
Create README.md with project overview and instructions
Added a comprehensive README with project details, structure, and contribution guidelines.
1 parent 32672b6 commit 4154931

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed

README.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# 🐍 code_python
2+
3+
A comprehensive collection of Python code examples and tutorials covering core concepts, object-oriented programming, concurrency, design patterns, and more.
4+
5+
---
6+
7+
## 📁 Repository Structure
8+
9+
| Folder | Description |
10+
|---|---|
11+
| [`Async_tutorial`](./Async_tutorial) | Asynchronous programming using `asyncio`, `async/await` patterns |
12+
| [`Exception_handling`](./Exception_handling) | Handling errors gracefully with try/except, custom exceptions |
13+
| [`Files`](./Files) | File I/O operations — reading, writing, and managing files |
14+
| [`Garbage_collection`](./Garbage_collection) | Python memory management and garbage collection internals |
15+
| [`Inheritance`](./Inheritance) | Class inheritance, method overriding, and MRO (Method Resolution Order) |
16+
| [`Iterators_and_Generators`](./Iterators_and_Generators) | Custom iterators, generator functions, and `yield` expressions |
17+
| [`Lambda_expression`](./Lambda_expression) | Anonymous functions, `map()`, `filter()`, and `reduce()` usage |
18+
| [`Pydantic_tutorial`](./Pydantic_tutorial) | Data validation and settings management using Pydantic |
19+
| [`Python_oops`](./Python_oops) | Object-Oriented Programming — classes, objects, encapsulation, polymorphism |
20+
| [`SOLID`](./SOLID) | SOLID design principles with Python examples |
21+
| [`Scalar`](./Scalar) | Scalar data types and operations |
22+
| [`Thread_tutorial`](./Thread_tutorial) | Multi-threading with the `threading` module |
23+
| [`Typing_Generics`](./Typing_Generics) | Type hints, generics, and the `typing` module |
24+
| [`absraction`](./absraction) | Abstraction using abstract base classes (`ABC`) |
25+
26+
---
27+
28+
## 🚀 Getting Started
29+
30+
### Prerequisites
31+
32+
- Python 3.8 or higher
33+
- pip (Python package manager)
34+
35+
### Clone the Repository
36+
37+
```bash
38+
git clone https://github.com/imashwini09/code_python.git
39+
cd code_python
40+
```
41+
42+
### Install Dependencies
43+
44+
Some modules (like Pydantic) may require additional packages:
45+
46+
```bash
47+
pip install pydantic
48+
```
49+
50+
### Run a Script
51+
52+
Navigate to any topic folder and run the desired Python file:
53+
54+
```bash
55+
cd Async_tutorial
56+
python <filename>.py
57+
```
58+
59+
---
60+
61+
## 📚 Topics Covered
62+
63+
- **OOP Concepts** — Classes, Objects, Encapsulation, Inheritance, Polymorphism, Abstraction
64+
- **Design Principles** — SOLID principles in Python
65+
- **Concurrency** — Threading and Async/Await patterns
66+
- **Functional Programming** — Lambda expressions, iterators, generators
67+
- **Type Safety** — Type hints, generics, and Pydantic data validation
68+
- **File Handling** — Reading and writing files
69+
- **Memory Management** — Python garbage collection
70+
- **Error Handling** — Exception handling best practices
71+
72+
---
73+
74+
## 🛠️ Tech Stack
75+
76+
- **Language:** Python 3.x
77+
- **Libraries:** Pydantic, asyncio, threading (standard library)
78+
- **CI/CD:** GitHub Actions (`.github/workflows`)
79+
80+
---
81+
82+
## 🤝 Contributing
83+
84+
Contributions are welcome! Feel free to open an issue or submit a pull request if you'd like to add examples or improve existing ones.
85+
86+
1. Fork the repository
87+
2. Create your feature branch (`git checkout -b feature/new-topic`)
88+
3. Commit your changes (`git commit -m 'Add new topic examples'`)
89+
4. Push to the branch (`git push origin feature/new-topic`)
90+
5. Open a Pull Request
91+
92+
---
93+
94+
## 📄 License
95+
96+
This project is open source. Feel free to use and learn from the code.
97+
98+
---
99+
100+
> Made with ❤️ by [imashwini09](https://github.com/imashwini09)

0 commit comments

Comments
 (0)