Initial commit

Author: yakhyo

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tools
+        run: pip install ruff mypy
+
+      - name: Ruff lint
+        run: ruff check .
+
+      - name: Ruff format check
+        run: ruff format --check .
+
+      - name: Mypy type check
+        run: mypy --strict .

.gitignore

@@ -0,0 +1,30 @@
+# IDEs
+.idea/
+.vscode/
+
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.egg-info/
+dist/
+build/
+
+# Type-checking / linting caches
+.mypy_cache/
+.ruff_cache/
+
+# Environment
+.env
+.venv/
+venv/
+
+# Jekyll
+_site/
+.jekyll-cache/
+.jekyll-metadata
+Gemfile.lock
+
+# OS
+.DS_Store
+Thumbs.db

Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.3"
+gem "just-the-docs", "~> 0.10"
+
+group :jekyll_plugins do
+  gem "jekyll-seo-tag"
+end

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Yakhyokhuja Valikhujaev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,73 @@
+# SOLID Principles in Python
+
+Learn the five SOLID design principles with small Python examples (**violation** vs **correct**) and UML class diagrams.
+
+- **Docs site**: `https://yakhyo.github.io/solid-python/`
+- **Source code**: `https://github.com/yakhyo/solid-python`
+
+## Requirements
+
+- **Python**: 3.10+ (for running the examples)
+- **Ruby**: 3.x + **Bundler** (only if you want to run the Jekyll docs locally)
+
+## Running the Python examples
+
+Each example is a standalone script (no external Python dependencies).
+
+```bash
+python srp/violation.py
+python srp/correct.py
+
+python ocp/violation.py
+python ocp/correct.py
+```
+
+## Running the documentation site locally (Jekyll)
+
+This repo uses the **just-the-docs** theme and includes a `Gemfile` for local runs.
+
+1) Install Ruby dependencies:
+
+```bash
+bundle install
+```
+
+2) Start the dev server:
+
+```bash
+bundle exec jekyll serve --livereload
+```
+
+3) Open the site:
+
+- This project uses `baseurl: /solid-python`, so the local URL is typically:
+  - `http://localhost:4000/solid-python/`
+
+### Optional: serve at `/` locally
+
+If you prefer `http://localhost:4000/` locally, override the baseurl:
+
+```bash
+bundle exec jekyll serve --livereload --baseurl ""
+```
+
+## Repository layout
+
+```text
+.
+├── index.md               # English docs home (Jekyll)
+├── index.uz.md            # Uzbek docs home (Jekyll)
+├── srp/ ocp/ lsp/ isp/ dip/
+│   ├── violation.py
+│   ├── correct.py
+│   ├── README.md          # English docs page
+│   └── README.uz.md       # Uzbek docs page
+├── assets/                # UML diagrams
+├── _config.yml            # Jekyll config
+└── Gemfile                # Jekyll dependencies
+```
+
+## License
+
+MIT — see `LICENSE` in the repository.
+

_config.yml

@@ -0,0 +1,68 @@
+title: SOLID Principles in Python
+description: Learn the five SOLID design principles with Python examples — violation vs correct, with UML diagrams.
+
+theme: just-the-docs
+
+url: "https://yakhyo.github.io"
+baseurl: "/solid-python"
+
+author:
+  name: Yakhyokhuja Valikhujaev
+  email: "yakhyo9696@gmail.com"
+
+aux_links:
+  "GitHub":
+    - "https://github.com/yakhyo/solid-python"
+
+aux_links_new_tab: true
+
+nav_sort: case_insensitive
+
+heading_anchors: true
+
+back_to_top: true
+back_to_top_text: "Back to top"
+
+enable_copy_code_button: true
+
+gh_edit_link: true
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/yakhyo/solid-python"
+gh_edit_branch: "main"
+gh_edit_source: ""
+gh_edit_view_mode: "edit"
+
+plugins:
+  - jekyll-seo-tag
+
+footer_content: >-
+  © 2025 Yakhyokhuja Valikhujaev.
+  Distributed under the <a href="https://github.com/yakhyo/solid-python/blob/main/LICENSE">MIT License</a>.
+
+color_scheme: light
+
+sass:
+  quiet_deps: true
+  silence_deprecations:
+    - import
+    - global-builtin
+    - color-functions
+
+exclude:
+  - "__pycache__"
+  - pyproject.toml
+  - Gemfile.lock
+  - README.md
+  - LICENSE
+  - .github
+
+callouts:
+  warning:
+    title: Warning
+    color: red
+  note:
+    title: Note
+    color: blue
+  tip:
+    title: Tip
+    color: green