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. It includes the Python backend, the docreview360 CLI, and a bundled copy of the Next.js frontend source for alpha testing.

python -m pip install --pre docreview360
python -m pip install --pre "docreview360[fedstylevalidator]"
docreview360 frontend extract ./docreview360-frontend

Use the fedstylevalidator extra when you want the published Federal Style Validator package from PyPI.

Quick start

Requirements:

  • Python 3.11 or 3.12
  • Node 18+ for the frontend
  • 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 from source for full-stack development:

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

Install the alpha package from PyPI:

python -m pip install --pre docreview360

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.3a0.tar.gz (866.4 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.3a0-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docreview360-0.1.3a0.tar.gz
  • Upload date:
  • Size: 866.4 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.3a0.tar.gz
Algorithm Hash digest
SHA256 952eda7d8554a7e3af16d1fe83f127f01b760825750d4f6a6d9f45a79575d412
MD5 f29b6157bc9645971b19285dd0e95959
BLAKE2b-256 4d74cd19b934c30ccee7fefbf2136cf88f135a3fb93a15b560d6436c41939695

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docreview360-0.1.3a0-py3-none-any.whl
  • Upload date:
  • Size: 1.1 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.3a0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b80b1c93d2beb4f350f14aea269d775ad046622832c21fca39599858b769eb8
MD5 4693a23cd68e8e1fcc6f812839211743
BLAKE2b-256 0e4bd07e996b9e8ed6ef39a7bdcfc4f16c8ba5d913e8db6c55f58fbe481ed189

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