Skip to content

Commit 8531ce4

Browse files
committed
chore: root directory cleanup - organize config, docs, and scripts (Feature 052)
- Added MIT LICENSE file for public repository - Moved configuration files to config/ (.flake8, .coveragerc, pytest-test.ini) - Moved docker-compose variants to config/docker/ (6 files) - Moved documentation to docs/ (CLAUDE.md, CONTRIBUTING.md, USER_GUIDE.md) - Moved shell scripts to scripts/ (activate_env.sh, docker-entrypoint-mcp.sh, etc) - Moved test artifacts to tests/artifacts/ (baseline_tests.txt) - Deleted temporary files (coverage.json) - Updated Makefile with new docker-compose paths (15 path references) This cleanup reduces root directory clutter while maintaining all functionality. Part of Feature 052: Root Directory Cleanup
1 parent 16a2547 commit 8531ce4

20 files changed

+39
-19
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 InterSystems Community
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Makefile

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# =============================================================================
66

77
# Default configuration
8-
COMPOSE_FILE := docker-compose.full.yml
8+
COMPOSE_FILE := config/docker/docker-compose.full.yml
99
ENV_FILE := .env
1010
PROJECT_NAME := rag-templates
1111

@@ -439,57 +439,57 @@ test-all-enterprise: test-enterprise-10k test-graphrag-scale test-pytest-enterpr
439439
.PHONY: test-db-basic
440440
test-db-basic: setup-db ## Switch to basic RAG test database
441441
$(call print_message,$(BLUE),Switching to Basic RAG Test Database)
442-
@docker-compose -f docker-compose.test.yml down iris-test 2>/dev/null || true
442+
@docker-compose -f config/docker/docker-compose.test.yml down iris-test 2>/dev/null || true
443443
@export TEST_DATABASE_VOLUME=$${TEST_DATABASE_VOLUME:-./docker/test-databases/basic-rag-testdb} && \
444-
docker-compose -f docker-compose.test.yml up -d iris-test
444+
docker-compose -f config/docker/docker-compose.test.yml up -d iris-test
445445
@sleep 15
446446
@python evaluation_framework/test_iris_connectivity.py --port 31972 || true
447447
$(call print_message,$(GREEN),Basic RAG test database ready)
448448

449449
.PHONY: test-db-graphrag
450450
test-db-graphrag: setup-db ## Switch to GraphRAG test database
451451
$(call print_message,$(BLUE),Switching to GraphRAG Test Database)
452-
@docker-compose -f docker-compose.test.yml down iris-test 2>/dev/null || true
452+
@docker-compose -f config/docker/docker-compose.test.yml down iris-test 2>/dev/null || true
453453
@export TEST_DATABASE_VOLUME=$${TEST_DATABASE_VOLUME:-./docker/test-databases/graphrag-testdb} && \
454-
docker-compose -f docker-compose.test.yml up -d iris-test
454+
docker-compose -f config/docker/docker-compose.test.yml up -d iris-test
455455
@sleep 15
456456
@python evaluation_framework/test_iris_connectivity.py --port 31972 || true
457457
$(call print_message,$(GREEN),GraphRAG test database ready)
458458

459459
.PHONY: test-db-crag
460460
test-db-crag: setup-db ## Switch to CRAG test database
461461
$(call print_message,$(BLUE),Switching to CRAG Test Database)
462-
@docker-compose -f docker-compose.test.yml down iris-test 2>/dev/null || true
462+
@docker-compose -f config/docker/docker-compose.test.yml down iris-test 2>/dev/null || true
463463
@export TEST_DATABASE_VOLUME=$${TEST_DATABASE_VOLUME:-./docker/test-databases/crag-testdb} && \
464-
docker-compose -f docker-compose.test.yml up -d iris-test
464+
docker-compose -f config/docker/docker-compose.test.yml up -d iris-test
465465
@sleep 15
466466
@python evaluation_framework/test_iris_connectivity.py --port 31972 || true
467467
$(call print_message,$(GREEN),CRAG test database ready)
468468

469469
.PHONY: test-db-enterprise
470470
test-db-enterprise: setup-db ## Switch to enterprise scale test database
471471
$(call print_message,$(BLUE),Switching to Enterprise Scale Test Database)
472-
@docker-compose -f docker-compose.test.yml down iris-test 2>/dev/null || true
472+
@docker-compose -f config/docker/docker-compose.test.yml down iris-test 2>/dev/null || true
473473
@export TEST_DATABASE_VOLUME=$${TEST_DATABASE_VOLUME:-./docker/test-databases/enterprise-testdb} && \
474-
docker-compose -f docker-compose.test.yml up -d iris-test
474+
docker-compose -f config/docker/docker-compose.test.yml up -d iris-test
475475
@sleep 30
476476
@python evaluation_framework/test_iris_connectivity.py --port 31972 || true
477477
$(call print_message,$(GREEN),Enterprise test database ready)
478478

479479
.PHONY: test-db-clean
480480
test-db-clean: setup-db ## Create fresh empty test database
481481
$(call print_message,$(BLUE),Creating Fresh Empty Test Database)
482-
@docker-compose -f docker-compose.test.yml down iris-test 2>/dev/null || true
482+
@docker-compose -f config/docker/docker-compose.test.yml down iris-test 2>/dev/null || true
483483
@docker volume rm rag-templates_test-iris-data 2>/dev/null || true
484-
@docker-compose -f docker-compose.test.yml up -d iris-test
484+
@docker-compose -f config/docker/docker-compose.test.yml up -d iris-test
485485
@sleep 15
486486
@python evaluation_framework/test_iris_connectivity.py --port 31972 || true
487487
$(call print_message,$(GREEN),Clean test database ready - framework auto-setup will handle schema)
488488

489489
.PHONY: test-db-status
490490
test-db-status: setup-db ## Show current test database status
491491
$(call print_message,$(BLUE),Test Database Status)
492-
@docker-compose -f docker-compose.test.yml ps iris-test 2>/dev/null || echo "No test database running"
492+
@docker-compose -f config/docker/docker-compose.test.yml ps iris-test 2>/dev/null || echo "No test database running"
493493
@python evaluation_framework/test_iris_connectivity.py --port 31972 && \
494494
python scripts/test-db/show_database_info.py 2>/dev/null || \
495495
echo "Test database not accessible"
@@ -1287,7 +1287,7 @@ mcp-build: ## Build MCP Docker image
12871287
.PHONY: mcp-run-standalone
12881288
mcp-run-standalone: env-check ## Start MCP server in standalone mode (stdio + HTTP/SSE)
12891289
$(call print_message,$(BLUE),Starting MCP server in standalone mode)
1290-
@docker-compose -f docker-compose.mcp.yml --profile standalone up -d
1290+
@docker-compose -f config/docker/docker-compose.mcp.yml --profile standalone up -d
12911291
@echo -e " $(GREEN)$(NC) MCP Server (standalone) is starting..."
12921292
@echo -e " $(BLUE)$(NC) Python Bridge: http://localhost:8001"
12931293
@echo -e " $(BLUE)$(NC) MCP HTTP/SSE: http://localhost:3000"
@@ -1298,7 +1298,7 @@ mcp-run-standalone: env-check ## Start MCP server in standalone mode (stdio + HT
12981298
.PHONY: mcp-run-integrated
12991299
mcp-run-integrated: env-check ## Start MCP server in integrated mode (embedded in REST API)
13001300
$(call print_message,$(BLUE),Starting MCP server in integrated mode)
1301-
@docker-compose -f docker-compose.mcp.yml --profile integrated up -d
1301+
@docker-compose -f config/docker/docker-compose.mcp.yml --profile integrated up -d
13021302
@echo -e " $(GREEN)$(NC) REST API with MCP integration is starting..."
13031303
@echo -e " $(BLUE)$(NC) REST API: http://localhost:8000"
13041304
@echo -e " $(BLUE)$(NC) API Docs: http://localhost:8000/docs"
@@ -1311,7 +1311,7 @@ mcp-run: mcp-run-standalone ## Alias for mcp-run-standalone (default mode)
13111311
.PHONY: mcp-stop
13121312
mcp-stop: ## Stop MCP server (all profiles)
13131313
$(call print_message,$(BLUE),Stopping MCP server)
1314-
@docker-compose -f docker-compose.mcp.yml --profile standalone --profile integrated down
1314+
@docker-compose -f config/docker/docker-compose.mcp.yml --profile standalone --profile integrated down
13151315
$(call print_message,$(GREEN),MCP server stopped)
13161316

13171317
.PHONY: mcp-restart
@@ -1342,9 +1342,9 @@ mcp-health: ## Check MCP server health
13421342
mcp-logs: ## View MCP server logs
13431343
$(call print_message,$(BLUE),Viewing MCP server logs)
13441344
@if docker ps --filter "name=mcp-standalone" --format "{{.Names}}" | grep -q "mcp-standalone"; then \
1345-
docker-compose -f docker-compose.mcp.yml --profile standalone logs -f mcp-standalone; \
1345+
docker-compose -f config/docker/docker-compose.mcp.yml --profile standalone logs -f mcp-standalone; \
13461346
elif docker ps --filter "name=api-with-mcp" --format "{{.Names}}" | grep -q "api-with-mcp"; then \
1347-
docker-compose -f docker-compose.mcp.yml --profile integrated logs -f api-with-mcp; \
1347+
docker-compose -f config/docker/docker-compose.mcp.yml --profile integrated logs -f api-with-mcp; \
13481348
else \
13491349
echo -e " $(RED)$(NC) No MCP server running"; \
13501350
fi
@@ -1426,7 +1426,7 @@ mcp-dev: env-check mcp-build mcp-run-standalone ## Full MCP development setup (b
14261426
.PHONY: mcp-clean
14271427
mcp-clean: mcp-stop ## Clean MCP Docker resources
14281428
$(call print_message,$(BLUE),Cleaning MCP Docker resources)
1429-
@docker-compose -f docker-compose.mcp.yml down -v
1429+
@docker-compose -f config/docker/docker-compose.mcp.yml down -v
14301430
@docker rmi iris-rag-mcp:latest 2>/dev/null || true
14311431
$(call print_message,$(GREEN),MCP resources cleaned)
14321432

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)