pyvisionai

(โ˜… 110)

The PyVisionAI Official Repo

  • .cursorrules
  • .flake8
  • .gitignore
  • .pre-commit-config.yaml
  • CHANGELOG.md
  • commit_message.txt
  • CONTRIBUTING.md
  • docker-compose.mcp.yml
  • docker-compose.yml
  • Dockerfile
  • Dockerfile.mcp
  • HYBRID_METHOD_DECISION.md
  • LICENSE
  • logging_migration_plan.md
  • pyproject.toml
  • pytest.ini
  • README.md
  • run_servers.sh
  • test_inventory.md
  • test_mcp_simple.py
  • test_refactoring_plan.md
  • THIRD_PARTY_LICENSES.md
  • TODO.md

# Installation Guide

1. Get the code
git clone https://github.com/MDGrey33/pyvisionai

Downloads the entire project code from GitHub to your computer.

cd pyvisionai

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew tap mdgrey33/pyvisionai

Registers this project's repository (tap) with Homebrew.

brew install pyvisionai

Installs the pre-built package via Homebrew โ€” no source build required.

brew install --cask libreoffice # Required for DOCX/PPTX processing

Installs the pre-built package via Homebrew โ€” no source build required.

brew install poppler # Required for PDF processing

Installs the pre-built package via Homebrew โ€” no source build required.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t pyvisionai-app .

Builds a runnable image based on the Dockerfile.

docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose down

Runs the command against the services defined in the compose file.

docker run -d \

Runs the built image as an actual container.

docker stop pyvisionai-container

Type this command into your terminal and run it.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install playwright # Required for HTML processing

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install playwright # Required for HTML processing

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install playwright

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install pyvisionai

Installs the package published on PyPI directly โ€” no need to clone the source.

poetry add pyvisionai

Type this command into your terminal and run it.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation