Skip to content

Latest commit

 

History

History
158 lines (98 loc) · 4.3 KB

README.md

File metadata and controls

158 lines (98 loc) · 4.3 KB
Raw

Automated Documentation 📇

with optional Ollama Integration

Automated Documentation

streamlines your digital workflow by meticulously logging your daily computer activities in a markdown document. From capturing website visits and clipboard changes to monitoring active windows and recording typed text, this tool enhances productivity and keeps detailed records for review. Perfect for professionals and personal use to keep track of digital interactions seamlessly.

Screenshots

Screenshot Program

Screenshot: the main program with built with customtkinter

Screenshot Output Example without Ollama

Screenshot: output example without Ollama

latest example output with OLLAMA: right here

Overview 🌟

Automated Documentation is a robust desktop application designed to log your daily computer activities comprehensively. From tracking visited websites to capturing text inputs, this tool ensures no significant details escape your notice. 🖥️📝

Features 🛠️

  • Website Tracking: Logs all URLs visited throughout the day.
  • Clipboard Monitoring: Monitors and records every change made to the clipboard.
  • Active Window Monitoring: Identifies which window is currently active and captures a screenshot each time it changes.
  • Text Monitoring: Records all typed text until the completion marked by pressing Enter.
  • Screenshot Capturing: Takes screenshots of active windows to provide a visual history.
  • Markdown Documentation: Compiles all recorded activities into a readable Markdown file.

Quick Start 🚀

Prerequisites

Ensure you have Python installed along with the following packages:

pip install customtkinter keyboard clipboard pygetwindow pyscreenshot markdown2 ollama

Installation

Installation on Linux

  1. Clone the repository or download the source code: 
    git clone https://github.com/tilltmk/automated-documentation.git
  2. Navigate to the project directory: 
    cd automated-documentation

Running

Execute the main script to start Automated Documentation:

python ActivityMonitor.py

Installation of required packages on Linux

Debian/Ubuntu
sudo apt-get update
sudo apt-get install python3-pip python3-tk xdotool scrot
sudo pip3 install -r requirements.txt
Arch Linux
sudo pacman -Syu
sudo pacman -S python-pip tk xdotool scrot
sudo pip install -r requirements.txt
openSUSE
sudo zypper refresh
sudo zypper install python3-pip python3-tk xdotool scrot
sudo pip3 install -r requirements.txt
Fedora
sudo dnf update
sudo dnf install python3-pip python3-tk xdotool scrot
sudo pip3 install -r requirements.txt

Installation of required packages on Windows 🖥️

  1. Clone the repository to your local machine. You can do this by running the following command in your Git Bash:
git clone https://github.com/tilltmk/automated-documentation
  1. This script requires several Python libraries. You can install them by running the following command in your command prompt:
pip install customtkinter keyboard clipboard ollama pyscreenshot pygetwindow
  1. Navigate to the directory containing the script and run it with Python:
cd automated-documentation
python script.py

Replace <directory> with the path to the directory containing the script.

🎉 Congratulations! You should now be able to run the Python script on your Windows computer!

Note: The exact steps may vary depending on your specific hardware and operating system. For specific questions or issues, we recommend consulting the official Python and library documentation or seeking help from online communities.

Configuration 🔧

Automated Documentation comes ready to use with default settings, but you can adjust the configurations to better meet your specific needs. Sudo / Root Access might be required on Linux.

Ollama Installation

Please refer to: https://github.com/ollama/ollama

Contributing 🤝

Just fork it.

License 📜

OpenSource under the GNU AFFERO GENERAL PUBLIC LICENSE V3. Please refer to LICENSE.md.