Skip to content

Latest commit

 

History

History
134 lines (88 loc) · 1.74 KB

File metadata and controls

134 lines (88 loc) · 1.74 KB

Installation Guide

Requirements

  • Python 3.10 or higher
  • pip or uv package manager

Installation Methods

Using pip (Recommended)

pip install permitcheck

Using uv

uv add permitcheck

From Source

git clone https://github.com/kirankotari/permitcheck.git
cd permitcheck
uv sync

Development Installation

For contributing or development:

git clone https://github.com/kirankotari/permitcheck.git
cd permitcheck
uv sync
uv run pytest  # Verify installation

Verify Installation

permitcheck --version

Expected output:

PermitCheck 2.0.0

Platform-Specific Notes

Linux

No additional steps required.

macOS

No additional steps required.

Windows

Use PowerShell or Command Prompt:

pip install permitcheck

Upgrading

From pip

pip install --upgrade permitcheck

From uv

uv add --upgrade permitcheck

Uninstallation

pip uninstall permitcheck

Troubleshooting

Permission Errors

On Linux/macOS, you may need to use:

pip install --user permitcheck

Or use a virtual environment (recommended):

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install permitcheck

Python Version Issues

Check your Python version:

python --version

If you have multiple Python versions, use:

python3.10 -m pip install permitcheck

Network Issues

If you're behind a proxy:

pip install --proxy http://proxy.example.com:8080 permitcheck

Next Steps