Update RM

Author: jamm1985

README.md

@@ -2,81 +2,220 @@
 
 ![image](https://github.com/user-attachments/assets/2846d6df-16de-4c24-b308-abb8534bd844)
 
-This is a template for python-based projects. Many DS/ML workflows require
-hardware-specific platforms in detailed OS-level libraries and python
-dependencies. In some cases, it is useful to perform code editing in the same
-environment in which applications are run. This template can help vim users to
-run vim-ide with the same project environment on a local or remote machine.
-Please, feel free to massage everything in the template as you wish.
+<!-- vim-markdown-toc GFM -->
 
-Vim is configured in a modern style and supports almost all ide-specific
-features. Please see `.vimrc.dist` for reference.
+* [🧰 About the Template](#-about-the-template)
+* [✅ Features](#-features)
+* [🧪 Tested with](#-tested-with)
+* [🚀 Getting Started](#-getting-started)
+  * [1. Configure environment and Python settings](#1-configure-environment-and-python-settings)
+  * [2. Set up Python project dependencies](#2-set-up-python-project-dependencies)
+  * [3. Build your Vim IDE image](#3-build-your-vim-ide-image)
+  * [4. Start developing inside the container](#4-start-developing-inside-the-container)
+  * [5. Update dependencies when needed](#5-update-dependencies-when-needed)
+  * [6. Build and run your application](#6-build-and-run-your-application)
+  * [📓 Optional: Run JupyterLab](#-optional-run-jupyterlab)
+* [🧠 Vim IDE Features](#-vim-ide-features)
+  * [✨ Core Capabilities](#-core-capabilities)
+  * [🔌Included Plugins](#included-plugins)
+    * [🧠 Code Intelligence](#-code-intelligence)
+    * [📁 Navigation & UI](#-navigation--ui)
+    * [🔄 Git Integration](#-git-integration)
+    * [📝 Markdown Support](#-markdown-support)
+    * [📊 Data Science & Python Dev](#-data-science--python-dev)
+    * [🎨 Theme & Aesthetics](#-theme--aesthetics)
+  * [⚙️ Python-Specific Tuning](#-python-specific-tuning)
+  * [🗂 Additional Notes](#-additional-notes)
 
-Tested under versions:
+<!-- vim-markdown-toc -->
 
-- docker `27.3.1`
-- buildx `2.32.1`
-- compose `2.32.1`
+## 🧰 About the Template
 
-## How to use template
+**vim-python-docker-template** is a lightweight, flexible starting point for
+containerized Python development. It’s especially well-suited for data science
+and machine learning workflows that require OS-level packages,
+hardware-specific dependencies, or reproducible environments.
 
-First, initialize the compose env, pick the required OS packages, and set the
-python/poetry versions:
+This template allows you to write and run code inside the same containerized
+environment using **Vim configured as a full-featured IDE** — making it ideal
+for both local and remote development.
 
-```bash
-cp .env.dist .env
-vim .env
-```
+Whether you're scripting pipelines, prototyping machine learning models, or
+building production tools, this setup provides a consistent, customizable
+workflow with Vim at the center.
+
+> ✨ Designed to work with *any* Python project — just plug in your code and
+> dependencies.
+
+The configuration is intentionally minimal and easy to adapt. You’re free to:
+- Add or update Python dependencies
+- Swap in different OS packages
+- Customize the Vim environment
+- Change Python or Poetry versions
+
+Use it as-is or tailor it to match your team's development workflow.
+
+---
+
+## ✅ Features
 
-Edit the poetry configuration file to manage python project-specific things and
-dependencies:
+- 📦 **Reproducible environments** for Python development
+- 🛠 **IDE-like Vim setup**, ready to go out of the box
+- 🐍 Supports custom **Python and Poetry** versions
+- 🧩 Simple to extend with Jupyter, SQL drivers, and more
+- 🔁 Works identically on any machine with Docker
+
+---
+
+## 🧪 Tested with
+
+- **Docker**: `27.3.1` – `28.2.2`
+- **buildx**: `0.20.0` – `0.25.0`
+- **Compose**: `2.32.1` – `2.37.1`
+
+---
+
+## 🚀 Getting Started
+
+### 1. Configure environment and Python settings
 
 ```bash
-vim pyproject.toml
+cp .env.dist .env
+vim .env  # Set OS packages, Python version, Poetry version, etc.
 ```
 
-Build python base image with poetry layer and create a lock file:
+### 2. Set up Python project dependencies
 
 ```bash
+vim pyproject.toml  # Edit dependencies, metadata, etc.
 docker compose build poetry
-docker compose run --rm poetry lock --no-cache
+docker compose run --rm poetry lock  # Generate poetry.lock
 git add poetry.lock
 ```
 
-Second, create the image with python dependencies and vim-ide on top of it:
+### 3. Build your Vim IDE image
 
 ```bash
 cp .vimrc.dist .vimrc
 cp .coc-settings.json.dist .coc-settings.json
-git config --local user.name "John Doe"
-git config --local user.email johndoe@example.com
+git config --local user.name "Your Name"
+git config --local user.email you@example.com
 docker compose build vim-ide
 ```
 
-Launch vim and do some development inside the container:
+### 4. Start developing inside the container
 
 ```bash
 docker compose run --rm vim-ide
 ```
 
-Don't forget to update the lock file:
+### 5. Update dependencies when needed
 
 ```bash
-docker compose run --rm poetry lock --no-cache
+docker compose run --rm poetry lock
 ```
 
-Finally, build and run your application:
+> 🔄 Note: If you've changed dependencies (e.g. updated pyproject.toml or
+> poetry.lock), you must rebuild the Vim IDE image to apply them:
+
+```bash
+docker compose build vim-ide
+docker compose run --rm vim-ide
+```
+
+### 6. Build and run your application
 
 ```bash
 docker compose build app
 docker compose run --rm app
 ```
 
-If desired, you can run Jupyter on top of the application:
+### 📓 Optional: Run JupyterLab
 
 ```bash
 docker compose build jupyterlab
 docker compose run --rm --service-ports jupyterlab
-# accsess http://127.0.0.1:8888/lab?token=<.env token>
+# Open: http://127.0.0.1:8888/lab?token=<your .env token>
 ```
 
+## 🧠 Vim IDE Features
+
+This template comes with a thoughtfully configured Vim environment that
+replicates many features you'd expect from a modern IDE. It’s built for
+productivity and designed to work out of the box — but is fully customizable.
+
+### ✨ Core Capabilities
+
+- ✅ Syntax highlighting & intelligent folding
+- ✅ Autocompletion and LSP features via `coc.nvim`
+- ✅ Linting, formatting, and diagnostics
+- ✅ Git integration and diff signs
+- ✅ Markdown editing with ToC, folding, and preview support
+- ✅ Snippets, code actions, and refactoring shortcuts
+- ✅ Enhanced status line, file tree, and fuzzy finding
+- ✅ Python-focused indentation, folding, and style enforcement
+
+---
+
+### 🔌Included Plugins
+
+#### 🧠 Code Intelligence
+
+- **[coc.nvim](https://github.com/neoclide/coc.nvim)** – LSP engine with autocompletion, diagnostics, and more
+- **[coc-pyright](https://github.com/fannheyward/coc-pyright)** – Python LSP support
+- **[ultisnips](https://github.com/SirVer/ultisnips)** + **[vim-snippets](https://github.com/honza/vim-snippets)** – Powerful snippet expansion
+
+#### 📁 Navigation & UI
+
+- **[NERDTree](https://github.com/preservim/nerdtree)** – File tree explorer
+- **[fzf.vim](https://github.com/junegunn/fzf.vim)** – Fuzzy file and symbol search
+- **[tagbar](https://github.com/preservim/tagbar)** – Code structure sidebar
+- **[vim-airline](https://github.com/vim-airline/vim-airline)** – Status/tab line enhancement
+
+#### 🔄 Git Integration
+
+- **[vim-fugitive](https://github.com/tpope/vim-fugitive)** – Git commands from within Vim
+- **[vim-gitgutter](https://github.com/airblade/vim-gitgutter)** – Git diff signs in the gutter
+
+#### 📝 Markdown Support
+
+- **[vim-markdown](https://github.com/plasticboy/vim-markdown)** – Markdown editing enhancements
+- **[vim-markdown-toc](https://github.com/mzlogin/vim-markdown-toc)** – Auto-generated table of contents
+
+#### 📊 Data Science & Python Dev
+
+- **[vim-slime](https://github.com/jpalardy/vim-slime)** – Send code to REPL or terminal
+- **[vim-doge](https://github.com/kkoomen/vim-doge)** – Generate docstrings in Google/Numpy style
+
+#### 🎨 Theme & Aesthetics
+
+- **[gruvbox-material](https://github.com/sainnhe/gruvbox-material)** – Color scheme (dark, high-contrast)
+- Airline integrated with Gruvbox  
+
+---
+
+### ⚙️ Python-Specific Tuning
+
+- Smart indentation for Python, with 4-space formatting
+- `textwidth` and `colorcolumn` set to PEP8 defaults
+- Spellcheck enabled for English and Russian
+- LSP-based completion, hover docs, jump-to-definition, code actions
+
+---
+
+### 🗂 Additional Notes
+
+- To customize the LSP setup, see `.coc-settings.json`
+- To update CoC extensions: `:CocUpdate`
+- Snippets can be edited under `~/.vim/plugged/vim-snippets`
+- Full configuration lives in `.vimrc.dist` — tweak freely
+
+This is a template for python-based projects. Many DS/ML workflows require
+hardware-specific platforms in detailed OS-level libraries and python
+dependencies. In some cases, it is useful to perform code editing in the same
+environment in which applications are run. This template can help vim users to
+run vim-ide with the same project environment on a local or remote machine.
+Please, feel free to massage everything in the template as you wish.
+
+Vim is configured in a modern style and supports almost all ide-specific
+features. Please see `.vimrc.dist` for reference.