Skip to content

Commit ebc94f8

Browse files
SimplicityGuyclaude
SimplicityGuy
and
claude
committed
fix: standardize mdformat versions and configuration across environments
- Add mdformat and plugins to dev dependencies with pinned versions - Update pre-commit config to use same plugin versions as dev dependencies - Add mdformat configuration to pyproject.toml for consistent behavior - Ensure mdformat is idempotent across all development environments This resolves formatting inconsistencies that were causing repeated documentation changes by ensuring all environments use the same mdformat version and plugins. Changes: - pyproject.toml: Added mdformat>=0.7.22, plugins, and tool configuration - .pre-commit-config.yaml: Pinned plugin versions to match dev dependencies - Documentation: Applied consistent formatting with new configuration 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6cd7fb4 commit ebc94f8

15 files changed

Lines changed: 428 additions & 335 deletions

‎.pre-commit-config.yaml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ repos:
3232
hooks:
3333
- id: mdformat
3434
additional_dependencies:
35-
- mdformat-black
35+
- mdformat-black==0.1.1
36+
- mdformat-gfm==0.4.1
37+
- mdformat-tables==1.0.0
3638

3739
- repo: https://github.com/astral-sh/ruff-pre-commit
3840
rev: db90487f48a9dd992d243ef63c156eaffddeaf28 # frozen: v0.12.11

‎README.md‎

Lines changed: 102 additions & 102 deletions
Large diffs are not rendered by default.

‎discovery/README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@ uv run python discovery/discovery.py
6464

6565
## 🌐 Service URLs
6666

67-
| Service | URL | Purpose |
67+
| Service | URL | Purpose |
6868
| ---------------- | ---------------------------- | -------------------------------- |
69-
| **Discovery UI** | http://localhost:8005 | Main interface with all features |
70-
| **Health Check** | http://localhost:8004/health | Service health status |
71-
| **API Docs** | http://localhost:8005/docs | Interactive API documentation |
69+
| **Discovery UI** | http://localhost:8005 | Main interface with all features |
70+
| **Health Check** | http://localhost:8004/health | Service health status |
71+
| **API Docs** | http://localhost:8005/docs | Interactive API documentation |
7272

7373
## 🎨 User Interface
7474

@@ -157,15 +157,15 @@ Content-Type: application/json
157157

158158
### Environment Variables
159159

160-
| Variable | Description | Default |
160+
| Variable | Description | Default |
161161
| ------------------- | -------------------- | ----------------------- |
162-
| `NEO4J_ADDRESS` | Neo4j connection URL | `bolt://localhost:7687` |
163-
| `NEO4J_USERNAME` | Neo4j username | `neo4j` |
164-
| `NEO4J_PASSWORD` | Neo4j password | Required |
165-
| `POSTGRES_ADDRESS` | PostgreSQL host:port | `localhost:5433` |
166-
| `POSTGRES_USERNAME` | PostgreSQL username | Required |
167-
| `POSTGRES_PASSWORD` | PostgreSQL password | Required |
168-
| `POSTGRES_DATABASE` | PostgreSQL database | `discogsography` |
162+
| `NEO4J_ADDRESS` | Neo4j connection URL | `bolt://localhost:7687` |
163+
| `NEO4J_USERNAME` | Neo4j username | `neo4j` |
164+
| `NEO4J_PASSWORD` | Neo4j password | Required |
165+
| `POSTGRES_ADDRESS` | PostgreSQL host:port | `localhost:5433` |
166+
| `POSTGRES_USERNAME` | PostgreSQL username | Required |
167+
| `POSTGRES_PASSWORD` | PostgreSQL password | Required |
168+
| `POSTGRES_DATABASE` | PostgreSQL database | `discogsography` |
169169

170170
### ML Model Configuration
171171

‎docker-optimization-results.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Summary of Size Reductions
44

5-
| Service | Before | After | Reduction | Percentage |
6-
|-------------|--------|--------|-----------|------------|
7-
| dashboard | 284MB | 253MB | 31MB | 10.9% |
8-
| extractor | 241MB | 210MB | 31MB | 12.9% |
9-
| graphinator | 251MB | 220MB | 31MB | 12.4% |
10-
| tableinator | 230MB | 199MB | 31MB | 13.5% |
11-
| discovery | 1.32GB | 982MB | 350MB | 26.5% |
5+
| Service | Before | After | Reduction | Percentage |
6+
| ----------- | ------ | ----- | --------- | ---------- |
7+
| dashboard | 284MB | 253MB | 31MB | 10.9% |
8+
| extractor | 241MB | 210MB | 31MB | 12.9% |
9+
| graphinator | 251MB | 220MB | 31MB | 12.4% |
10+
| tableinator | 230MB | 199MB | 31MB | 13.5% |
11+
| discovery | 1.32GB | 982MB | 350MB | 26.5% |
1212

1313
**Total reduction across all services: 474MB**
1414

‎docs/README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,33 @@
1212

1313
### 🏗️ Development & Standards
1414

15-
| Document | Description |
15+
| Document | Description |
1616
| ------------------------------------------------------------- | ----------------------------------------------------------- |
17-
| **[Dockerfile Standards](dockerfile-standards.md)** | 🐋 Best practices for writing secure, efficient Dockerfiles |
18-
| **[Monorepo Guide](monorepo-guide.md)** | 📦 Managing a Python monorepo with shared dependencies |
19-
| **[Python Version Management](python-version-management.md)** | 🐍 Managing Python 3.13+ across the project |
20-
| **[Platform Targeting](platform-targeting.md)** | 🎯 Cross-platform compatibility guidelines |
21-
| **[Logging Guide](logging-guide.md)** | 📊 Structured logging standards and best practices |
22-
| **[Testing Guide](testing-guide.md)** | 🧪 Comprehensive testing strategies and patterns |
17+
| **[Dockerfile Standards](dockerfile-standards.md)** | 🐋 Best practices for writing secure, efficient Dockerfiles |
18+
| **[Monorepo Guide](monorepo-guide.md)** | 📦 Managing a Python monorepo with shared dependencies |
19+
| **[Python Version Management](python-version-management.md)** | 🐍 Managing Python 3.13+ across the project |
20+
| **[Platform Targeting](platform-targeting.md)** | 🎯 Cross-platform compatibility guidelines |
21+
| **[Logging Guide](logging-guide.md)** | 📊 Structured logging standards and best practices |
22+
| **[Testing Guide](testing-guide.md)** | 🧪 Comprehensive testing strategies and patterns |
2323

2424
### 🚀 Operations & Deployment
2525

26-
| Document | Description |
26+
| Document | Description |
2727
| --------------------------------------------------- | ------------------------------------------------ |
28-
| **[GitHub Actions Guide](github-actions-guide.md)** | 🔄 CI/CD workflows, automation & best practices |
29-
| **[Task Automation](task-automation.md)** | ⚡ Complete taskipy command reference |
30-
| **[Docker Security](docker-security.md)** | 🔒 Container hardening & security practices |
31-
| **[Database Resilience](database-resilience.md)** | 💾 Database connection patterns & error handling |
32-
| **[Performance Guide](performance-guide.md)** | ⚡ Performance optimization strategies |
28+
| **[GitHub Actions Guide](github-actions-guide.md)** | 🔄 CI/CD workflows, automation & best practices |
29+
| **[Task Automation](task-automation.md)** | ⚡ Complete taskipy command reference |
30+
| **[Docker Security](docker-security.md)** | 🔒 Container hardening & security practices |
31+
| **[Database Resilience](database-resilience.md)** | 💾 Database connection patterns & error handling |
32+
| **[Performance Guide](performance-guide.md)** | ⚡ Performance optimization strategies |
3333

3434
### 📋 Features & Updates
3535

36-
| Document | Description |
36+
| Document | Description |
3737
| ----------------------------------------------------------- | -------------------------------------------------------- |
38-
| **[Consumer Cancellation](consumer-cancellation.md)** | 🔄 File completion and consumer lifecycle management |
38+
| **[Consumer Cancellation](consumer-cancellation.md)** | 🔄 File completion and consumer lifecycle management |
3939
| **[File Completion Tracking](file-completion-tracking.md)** | 📊 Intelligent completion tracking and stalled detection |
40-
| **[Recent Improvements](recent-improvements.md)** | 🚀 Latest platform enhancements and changes |
41-
| **[Emoji Guide](emoji-guide.md)** | 📋 Standardized emoji usage across the project |
40+
| **[Recent Improvements](recent-improvements.md)** | 🚀 Latest platform enhancements and changes |
41+
| **[Emoji Guide](emoji-guide.md)** | 📋 Standardized emoji usage across the project |
4242

4343
## 🎯 Quick Links by Topic
4444

‎docs/emoji-guide.md‎

Lines changed: 96 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -16,131 +16,131 @@ Emojis in Discogsography serve to:
1616

1717
### Service Identifiers
1818

19-
| Emoji | Service | Usage |
19+
| Emoji | Service | Usage |
2020
| ----- | ---------------- | ---------------------------------------------- |
21-
| 📥 | Python Extractor | Python-based data extraction service |
22-
| ⚡ | Rust Extractor | Rust-based high-performance extraction service |
23-
| 🔗 | Graphinator | Neo4j graph service |
24-
| 🐘 | Tableinator | PostgreSQL service |
25-
| 🎵 | Discovery | Music discovery service |
26-
| 📊 | Dashboard | Analytics dashboard |
27-
| 🐰 | RabbitMQ | Message broker |
21+
| 📥 | Python Extractor | Python-based data extraction service |
22+
| ⚡ | Rust Extractor | Rust-based high-performance extraction service |
23+
| 🔗 | Graphinator | Neo4j graph service |
24+
| 🐘 | Tableinator | PostgreSQL service |
25+
| 🎵 | Discovery | Music discovery service |
26+
| 📊 | Dashboard | Analytics dashboard |
27+
| 🐰 | RabbitMQ | Message broker |
2828

2929
### Status Indicators
3030

31-
| Emoji | Status | Usage |
31+
| Emoji | Status | Usage |
3232
| ----- | ------------- | -------------------------------- |
33-
| 🚀 | Startup | Service initialization |
34-
| ✅ | Success | Operation completed successfully |
35-
| ❌ | Error | Operation failed |
36-
| ⚠️ | Warning | Non-critical issue |
37-
| 🔄 | Processing | Operation in progress |
38-
| ⏳ | Waiting | Pending or queued state |
39-
| 💾 | Saved | Data persisted |
40-
| 🔧 | Configuration | Setup or config change |
33+
| 🚀 | Startup | Service initialization |
34+
| ✅ | Success | Operation completed successfully |
35+
| ❌ | Error | Operation failed |
36+
| ⚠️ | Warning | Non-critical issue |
37+
| 🔄 | Processing | Operation in progress |
38+
| ⏳ | Waiting | Pending or queued state |
39+
| 💾 | Saved | Data persisted |
40+
| 🔧 | Configuration | Setup or config change |
4141

4242
### Documentation Sections
4343

44-
| Emoji | Section | Usage |
44+
| Emoji | Section | Usage |
4545
| ----- | ------------- | ---------------------- |
46-
| 🎯 | Overview | Project goals, targets |
47-
| 🚀 | Quick Start | Getting started guides |
48-
| 📖 | Documentation | Links to docs |
49-
| 💬 | Community | Support channels |
50-
| 🌟 | Features | Key capabilities |
51-
| ⚙️ | Configuration | Settings, setup |
52-
| 📐 | Architecture | System design |
53-
| 🛡️ | Security | Security features |
54-
| 📊 | Monitoring | Observability |
55-
| 🧪 | Testing | Test coverage |
56-
| ✅ | Prerequisites | Requirements |
57-
| 💿 | Dataset | Data information |
46+
| 🎯 | Overview | Project goals, targets |
47+
| 🚀 | Quick Start | Getting started guides |
48+
| 📖 | Documentation | Links to docs |
49+
| 💬 | Community | Support channels |
50+
| 🌟 | Features | Key capabilities |
51+
| ⚙️ | Configuration | Settings, setup |
52+
| 📐 | Architecture | System design |
53+
| 🛡️ | Security | Security features |
54+
| 📊 | Monitoring | Observability |
55+
| 🧪 | Testing | Test coverage |
56+
| ✅ | Prerequisites | Requirements |
57+
| 💿 | Dataset | Data information |
5858

5959
### Operation Types
6060

61-
| Emoji | Operation | Usage |
61+
| Emoji | Operation | Usage |
6262
| ----- | ----------- | ----------------------- |
63-
| 📊 | Analytics | Statistics, metrics |
64-
| 🤖 | AI/ML | Model operations |
65-
| 🧠 | ML Model | Model loading |
66-
| 🔗 | Graph Ops | Graph building |
67-
| 🧬 | Embeddings | Vector generation |
68-
| 🎵 | Music Ops | Music-specific tasks |
69-
| 📈 | Analytics | Analysis operations |
70-
| 🏘️ | Community | Neighborhood/clustering |
71-
| 🛤️ | Pathfinding | Graph traversal |
72-
| ⬇️ | Download | Data fetching |
73-
| 📋 | Metadata | Information display |
74-
| 📄 | File Ops | File operations |
75-
| 🏥 | Health | Health checks |
63+
| 📊 | Analytics | Statistics, metrics |
64+
| 🤖 | AI/ML | Model operations |
65+
| 🧠 | ML Model | Model loading |
66+
| 🔗 | Graph Ops | Graph building |
67+
| 🧬 | Embeddings | Vector generation |
68+
| 🎵 | Music Ops | Music-specific tasks |
69+
| 📈 | Analytics | Analysis operations |
70+
| 🏘️ | Community | Neighborhood/clustering |
71+
| 🛤️ | Pathfinding | Graph traversal |
72+
| ⬇️ | Download | Data fetching |
73+
| 📋 | Metadata | Information display |
74+
| 📄 | File Ops | File operations |
75+
| 🏥 | Health | Health checks |
7676

7777
### Music Domain
7878

79-
| Emoji | Entity | Usage |
79+
| Emoji | Entity | Usage |
8080
| ----- | -------- | ----------------------- |
81-
| 🎵 | Music | General music reference |
82-
| 🎤 | Artists | Artist entities |
83-
| 💿 | Albums | Album/release entities |
84-
| 📀 | Releases | Physical releases |
81+
| 🎵 | Music | General music reference |
82+
| 🎤 | Artists | Artist entities |
83+
| 💿 | Albums | Album/release entities |
84+
| 📀 | Releases | Physical releases |
8585

8686
### Development
8787

88-
| Emoji | Purpose | Usage |
88+
| Emoji | Purpose | Usage |
8989
| ----- | ----------- | --------------------- |
90-
| 💡 | Tips | Pro tips, insights |
91-
| 🤖 | AI/Claude | AI assistance |
92-
| 📚 | Reference | Quick reference |
93-
| 🛠️ | Development | Dev commands |
94-
| 📋 | Guidelines | Rules, checklists |
95-
| 🏗️ | Building | Architecture, Docker |
96-
| 🔍 | Debugging | Search, investigation |
97-
| 📦 | Container | Docker status |
90+
| 💡 | Tips | Pro tips, insights |
91+
| 🤖 | AI/Claude | AI assistance |
92+
| 📚 | Reference | Quick reference |
93+
| 🛠️ | Development | Dev commands |
94+
| 📋 | Guidelines | Rules, checklists |
95+
| 🏗️ | Building | Architecture, Docker |
96+
| 🔍 | Debugging | Search, investigation |
97+
| 📦 | Container | Docker status |
9898

9999
### CI/CD & GitHub Actions
100100

101-
| Emoji | Purpose | Usage |
101+
| Emoji | Purpose | Usage |
102102
| ----- | --------------- | --------------------- |
103-
| 🔀 | Checkout | Repository checkout |
104-
| 🐍 | Python | Python setup |
105-
| 📦 | Package Manager | UV/pip installation |
106-
| 💾 | Cache | Caching operations |
107-
| 🧪 | Testing | Test execution |
108-
| 🔧 | Setup/Config | Configuration steps |
109-
| 📊 | Metrics | Performance tracking |
110-
| 🔒 | Security | Login, permissions |
111-
| 🛡️ | Scanning | Security scanning |
112-
| 🚀 | Build/Deploy | Build and deployment |
113-
| 📢 | Notifications | Discord, alerts |
114-
| 🏷️ | Tagging | Version tags, labels |
115-
| ⏱️ | Timing | Performance timing |
116-
| 🎯 | Target | Goals, objectives |
117-
| ✅ | Success | Successful completion |
118-
| ❌ | Failure | Failed operations |
119-
| ⏭️ | Skip | Skipped steps |
120-
| 🔄 | Retry | Retry operations |
121-
| 🧹 | Cleanup | Cache/image cleanup |
122-
| 📝 | Documentation | PR creation |
123-
| 🐳 | Docker | Docker operations |
124-
| 🎭 | Playwright | E2E testing |
125-
| 📤 | Upload | Artifact upload |
126-
| 🎥 | Recording | Video capture |
127-
| 🌐 | Browser | Browser testing |
128-
| 📱 | Mobile | Mobile testing |
129-
| 🐛 | Debug | Debugging steps |
103+
| 🔀 | Checkout | Repository checkout |
104+
| 🐍 | Python | Python setup |
105+
| 📦 | Package Manager | UV/pip installation |
106+
| 💾 | Cache | Caching operations |
107+
| 🧪 | Testing | Test execution |
108+
| 🔧 | Setup/Config | Configuration steps |
109+
| 📊 | Metrics | Performance tracking |
110+
| 🔒 | Security | Login, permissions |
111+
| 🛡️ | Scanning | Security scanning |
112+
| 🚀 | Build/Deploy | Build and deployment |
113+
| 📢 | Notifications | Discord, alerts |
114+
| 🏷️ | Tagging | Version tags, labels |
115+
| ⏱️ | Timing | Performance timing |
116+
| 🎯 | Target | Goals, objectives |
117+
| ✅ | Success | Successful completion |
118+
| ❌ | Failure | Failed operations |
119+
| ⏭️ | Skip | Skipped steps |
120+
| 🔄 | Retry | Retry operations |
121+
| 🧹 | Cleanup | Cache/image cleanup |
122+
| 📝 | Documentation | PR creation |
123+
| 🐳 | Docker | Docker operations |
124+
| 🎭 | Playwright | E2E testing |
125+
| 📤 | Upload | Artifact upload |
126+
| 🎥 | Recording | Video capture |
127+
| 🌐 | Browser | Browser testing |
128+
| 📱 | Mobile | Mobile testing |
129+
| 🐛 | Debug | Debugging steps |
130130

131131
### Performance & Features
132132

133-
| Emoji | Feature | Usage |
133+
| Emoji | Feature | Usage |
134134
| ----- | ------------- | ------------------- |
135-
| ⚡ | Speed | High performance |
136-
| 🔄 | Deduplication | Smart dedup |
137-
| 📈 | Big Data | Large scale |
138-
| 🎯 | Concurrency | Parallel processing |
139-
| 🔁 | Recovery | Auto-recovery |
140-
| 🏥 | Monitoring | Health monitoring |
141-
| 📝 | Type Safety | Type checking |
142-
| 🔍 | Search | Search capabilities |
143-
| 🎨 | Visualization | UI/graphics |
135+
| ⚡ | Speed | High performance |
136+
| 🔄 | Deduplication | Smart dedup |
137+
| 📈 | Big Data | Large scale |
138+
| 🎯 | Concurrency | Parallel processing |
139+
| 🔁 | Recovery | Auto-recovery |
140+
| 🏥 | Monitoring | Health monitoring |
141+
| 📝 | Type Safety | Type checking |
142+
| 🔍 | Search | Search capabilities |
143+
| 🎨 | Visualization | UI/graphics |
144144

145145
## Usage Guidelines
146146

0 commit comments

Comments
 (0)