Spaces:

KashiAI
/

KCH

Sleeping

App Files Files Community

KCH / README.md

bsamadi

Update README.md

794892e verified 2 months ago

preview code

raw

history blame contribute delete

2.79 kB

metadata

title: Kashi Coding Handbook
description: A handbook for coding best practices and guidelines
author: KashiAI
colorFrom: green
colorTo: pink
sdk: docker
pinned: false
license: mit
thumbnail: >-
  https://cdn-uploads.huggingface.co/production/uploads/6455a62fbda0fbba412d170d/k8-D6PGmmfUulVCehX2_J.png

KashiAI Logo

Kashi Coding Handbook

Build AI-powered CLI tools with Python, from modern packaging to production deployment.

What is this?

The Kashi Coding Handbook is a comprehensive, project-driven guide for:

Python developers and data scientists building robust CLI tools
AI engineers integrating LLMs and multi-agent systems
Anyone seeking reproducible, production-grade Python workflows

The handbook is a Quarto website (see src/) with:

7 core chapters (see src/chapters/)
Real-world projects (see docs/projects/)
A 12-month content plan and learning path
Deep dives on Docker AI, MCP, and more

Quickstart

# 1. Install Quarto (https://quarto.org/docs/get-started/)
# 2. Clone this repo and install dependencies (pixi recommended)
git clone <this-repo-url>
cd KCH
pixi install
# 3. Preview the site
quarto preview src

We recommend the Quarto VS Code Extension for syntax highlighting, code completion, and live preview.

Handbook Structure

The handbook is organized as follows (see src/_quarto.yml):

Chapter 1: Foundation Setup – Environment, project structure
Chapter 2: CLI Development – Typer, config management
Chapter 3: AI Integration – HuggingFace, Docker, MCP, prompt engineering
Chapter 4: Advanced Features – Interactive elements, batch processing
Chapter 5: Testing & Quality – Tests, code quality
Chapter 6: Publishing – Packaging, PyPI
Chapter 7: Real-World Projects – e.g., FileOrganizer
Appendices – Pixi commands, learning resources

See src/chapters/ for all chapter sources.

Documentation & Resources

Learning Path: Step-by-step curriculum
Content Plan: 12-month roadmap
Docker AI Guide: LLM/MCP deployment
Project Blueprints: Real-world project specs

Contributing

Contributions, suggestions, and questions are welcome!

Fork the repo and create a feature branch
Open a pull request with a clear description
For major changes, please open an issue first to discuss

License

MIT