diff --git a/README.md b/README.md index 86ba9f1..8d3194d 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,37 @@ -# AI Fluency Plan +# AI Fluency Personal Plan -## Project Overview +This repository contains a simple Python script that generates a **personal AI fluency plan** based on the course structure described in the assignment. The plan is deterministic and does not rely on any external services or APIs. -This repository contains a simple Python project that demonstrates how to store, load and analyze a personal **AI fluency plan**. The goal of the assignment is to provide a clear, well‑structured example that can be reused for future coursework or as a template. +## Project Structure -The main components are: - -* `main.py` – entry point with three example usages (print full plan, first five lines, word count). -* `plan.txt` – the actual AI fluency plan written in plain text. -* `requirements.txt` – minimal dependencies required to run the project. - -The code follows the guidelines from the assignment: - -* No `pass`, `TODO` or placeholders. -* Each file contains more than 80 lines of real code (except for data files). -* The LLM configuration is omitted because this repository does not invoke an LLM directly – it only loads a static plan. If you want to extend the project with LangChain, add the appropriate imports and tools. +``` +├── main.py # Generates and prints the plan +├── requirements.txt # Empty – no third‑party dependencies are required +└── README.md # This file +``` ## Installation +No installation is necessary. The script uses only the Python standard library. + ```bash -# Clone the repo -git clone https://git.brojs.ru/KirillKutlakhmetov/task-69970ff6d6d3a5544a3def7a.git -cd task-69970ff6d6d3a5544a3def7a - -# Create a virtual environment (optional but recommended) -python -m venv .venv -source .venv/bin/activate # On Windows use `.venv\Scripts\activate` - -# Install dependencies -pip install -r requirements.txt +python3 -m pip install --upgrade pip # optional, for a clean environment ``` ## Usage +Run the script directly: + ```bash python main.py ``` -The script will: -1. Print the entire AI fluency plan. -2. Show only the first five lines of the plan. -3. Output the total word count. +The output will be a formatted plan with sections such as *Foundational Knowledge*, *Hands‑on Projects*, *Advanced Topics*, etc. -Feel free to modify `plan.txt` or extend `main.py` with additional analysis functions. +## How it Works -## Project Structure +* `Plan`, `PlanSection`, and `PlanItem` are simple dataclasses that hold the structure of the plan. +* `generate_plan()` builds a deterministic plan based on the course timeline. +* The `main()` function prints the plan to stdout. -``` -├── main.py # Entry point and example usage -├── plan.txt # Personal AI fluency plan (plain text) -├── requirements.txt # Python dependencies -└── README.md # Documentation -``` - -## License - -This project is released under the MIT license. +The script is intentionally straightforward – it demonstrates how to produce structured, human‑readable output without external dependencies.