Skip to main content

DocReview360 simplifies document workflows with approvals and templates.

Project description

DocReview360

DocReview360 is a document review app with a FastAPI backend, a React frontend, and a CLI. It helps teams route documents through review, approvals, and audit logging.

Alpha release

The current PyPI release is an alpha package. The base install is the lightweight web review app: FastAPI backend, docreview360 CLI, SQLite support, TipTap authoring/review, core notifications, reviewer management, and the packaged frontend build asset when release artifacts are built with a frontend bundle. ML, async workers, enterprise auth, production database drivers, and advanced editor/collaboration paths are optional extras.

python -m pip install --pre docreview360
docreview360 init
docreview360 migrate
docreview360 serve

Add runtime capabilities later with extras, then configure them in the frontend Configuration area:

python -m pip install --pre "docreview360[postgres]"
python -m pip install --pre "docreview360[ml-cpu]"
python -m pip install --pre "docreview360[full]"
docreview360 capabilities

Quick start

Requirements:

  • Python 3.11 or 3.12
  • Node 18+ for frontend source development
  • uv recommended for environment management

Backend:

git clone https://github.com/eputnam77/DocReview360.git
cd DocReview360
uv venv --python 3.12
source .venv/bin/activate
uv pip install -e ".[dev,test,security]"
DOCREVIEW360_ENV=dev python -m uvicorn docreview360.api:app --reload --host 0.0.0.0 --port 8000

Frontend:

cd frontend
npm install --legacy-peer-deps
printf "NEXT_PUBLIC_API_BASE=http://localhost:8000\n" > .env.local
npm run dev

Windows PowerShell:

uv venv --python 3.12
.venv\Scripts\Activate.ps1
python -m pip install -e ".[dev,test,security]"
$env:DOCREVIEW360_ENV="dev"
python -m uvicorn docreview360.api:app --reload --host 0.0.0.0 --port 8000

Log in with alice / password or bob / password in local development.

For the full setup flow, see docs/getting_started.md.

Install options

Install the lightweight web app from PyPI:

python -m pip install --pre docreview360
docreview360 init
docreview360 migrate
docreview360 serve

Install optional runtime capabilities:

python -m pip install --pre "docreview360[postgres]"
python -m pip install --pre "docreview360[worker]"
python -m pip install --pre "docreview360[ml-cpu]"
python -m pip install --pre "docreview360[saml]"

Install from source for full-stack development:

uv pip install -e ".[dev,test,security]"

Need a plain venv flow instead of uv? See docs/getting_started.md.

Configuration

Keep the README focused. Use the docs for configuration detail.

Run the setup wizard to generate docreview360.yaml:

docreview360 init

Testing and quality

Quality checks, security scans, and E2E commands now live in one place:

Product notes

  • Existing endpoints remain available without a prefix.
  • Versioned aliases are supported at /api/v1/*.
  • AI assistance is optional.
  • The app is not legal advice and is not positioned as a certified regulatory compliance system.

Performance baseline details live in docs/performance_baseline.md.

Packaging and release

Release packaging details live in docs/release_packaging.md.

More docs

Governance

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docreview360-0.1.3a1.tar.gz (529.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docreview360-0.1.3a1-py3-none-any.whl (3.3 MB view details)

Uploaded Python 3

File details

Details for the file docreview360-0.1.3a1.tar.gz.

File metadata

  • Download URL: docreview360-0.1.3a1.tar.gz
  • Upload date:
  • Size: 529.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for docreview360-0.1.3a1.tar.gz
Algorithm Hash digest
SHA256 4538fa04998484c639ebe41355816770c5014308f5facd70fd7481155338b253
MD5 3c91d54e5916b1fec6dfcee7312f3c98
BLAKE2b-256 3e8175733c57b185d79b55167d02a57ed3f524ab85c5c934eb8da61460c5261f

See more details on using hashes here.

File details

Details for the file docreview360-0.1.3a1-py3-none-any.whl.

File metadata

  • Download URL: docreview360-0.1.3a1-py3-none-any.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for docreview360-0.1.3a1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d579531d6c445bec43116c7d092b20055b8a98cb5477aa64b6f94583d6e583a
MD5 66d86e2e17bbeb3b4b391654f5801995
BLAKE2b-256 749b68bae93c7cc2bc41c75b50e21bd466b41a7de0357c1a7845998a0da7c92d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page