Book Recommender (Enterprise-Grade)

Overview

Book Recommender is a modular, production-ready open-source project for intelligent, secure, and extensible book recommendations. Built for clarity, security, and professional review, it follows Clean Code, SOLID, and GitGuardian security standards.

---

Problem Statement

Finding relevant books is hard. Most recommenders are generic, slow, or insecure. This project delivers fast, personalized, and secure recommendations using modern LLMs and the Google Books API.

Architecture

Modular Structure:

book_recommender_using_langchain/
├── src/
│   └── book_recommender/      # Core logic (modular, SOLID)
├── config/                    # Configuration, secrets, logging
├── scripts/                   # Automation, utilities
├── tests/                     # Unit & integration tests
├── docs/                      # API, architecture, ADRs
├── .env.example               # Environment variable template
├── .gitignore                 # Security-focused ignores
├── SECURITY.md                # Security policy
├── CHANGELOG.md               # Release notes
├── README.md                  # This file
└── ...

See docs/ARCHITECTURE.md for details.

Tech Stack

• Python 3.10+
• Langchain, Gradio, Google Books API
• Structured logging, dotenv, pytest, ruff, black

Setup & Usage

1. Clone the repository

   git clone <your-repo-url>
   cd Book_Recommender_Using_Langchain

2. Configure environment

   cp .env.example .env
   # Edit .env and add your GOOGLE_BOOKS_API_KEY

3. Install dependencies

   pip install -r requirements.txt

4. Run the application

   python book_recommender.py

Visit http://localhost:7860 to use the UI.

Security & Best Practices

• No hardcoded secrets; use .env and config/
• Sensitive files and environments are gitignored
• See SECURITY.md for responsible disclosure

Testing

• Tests in tests/ (unit & integration)
• Example:

  pytest
  pytest --cov=src/book_recommender

• Coverage goal: 80%+
• See CONTRIBUTING.md for test writing guidelines

Code Quality

• Lint: ruff check src/ tests/
• Format: black src/ tests/
• Pre-commit: pre-commit run --all-files
• All code is type-annotated and documented

CI/CD

• Recommended: GitHub Actions (see .github/workflows/)
• Run tests, lint, and security checks on every PR

Documentation

• ARCHITECTURE.md: System design
• API.md: API reference
• CONTRIBUTING.md: How to contribute
• CHANGELOG.md: Release history

Value Proposition

• Recruiter- and reviewer-friendly: Clean, modular, and well-documented
• Secure by default: No secrets in code, safe input handling
• Easy to extend: Add new recommenders, UIs, or data sources
• Production-ready: Logging, error handling, and test coverage

License

MIT

---

For questions or contributions, see CONTRIBUTING.md.