59 lines
1.9 KiB
Markdown
59 lines
1.9 KiB
Markdown
# AI Fluency Plan
|
||
|
||
## Project Overview
|
||
|
||
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.
|
||
|
||
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.
|
||
|
||
## Installation
|
||
|
||
```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
|
||
```
|
||
|
||
## Usage
|
||
|
||
```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.
|
||
|
||
Feel free to modify `plan.txt` or extend `main.py` with additional analysis functions.
|
||
|
||
## Project Structure
|
||
|
||
```
|
||
├── 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.
|