design-patterns

design-patterns

Design patterns in Python
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Security
6. Code of Conduct
7. License
8. Contact

About the project

This project is about Design Patterns in Python that includes the S.O.L.I.D. principles and the Gamma Categorization for 23 design patterns classified into Creational, Behavioral and Structural based on Clean Code: A Handbook of Agile Software Craftsmanship by Robert C. Martin.

(back to top)

Built with

(back to top)

Getting started

Prerequisites

• Python 3.11

Installation

1. Clone the repository

   git clone https://github.com/jpcadena/design-patterns.git
   

2. Change the directory to root project

   cd design-patterns
   

3. Install Poetry package manager

   pip install poetry
   

4. Install the project's dependencies

   poetry install
   

5. Activate the environment

   poetry shell
   

(back to top)

Usage

1. Execute with console

   python main.py
   

(back to top)

Contributing

Please read our contributing guide for details on our code of conduct, and the process for submitting pull requests to us.

(back to top)

Security

For security considerations and best practices, please refer to our Security Guide for a detailed guide.

(back to top)

Code of Conduct

We enforce a code of conduct for all maintainers and contributors. Please read our Code of Conduct to understand the expectations before making any contributions.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

• 

• 

(back to top)