Skip to main content

​
Repository layout

ViscribeAI is a dual-language SDK. Keep Python and TypeScript behavior aligned unless a change is intentionally scoped to one package.
  • python/: Python package, examples, and tests.
  • typescript/: TypeScript package, examples, and tests.
  • docs/: Mintlify documentation.
  • CONTRIBUTING.md: repository contribution guide.
  • ROADMAP.md: planned capabilities and longer-term direction.

​
Local setup

Install repository tooling from the repo root. 
npm install
Install Python dependencies. 
cd python
uv sync
Install TypeScript dependencies. 
cd typescript
npm install
Create a root .env file only for local live examples. 
OPENAI_API_KEY=sk-your-provider-key
OPENAI_MODEL=gpt-5-mini
Do not commit .env files or provider credentials.

​
Verification

Run the checks that match the files you changed. 
cd python
uv run python -m pytest
uv run ruff check .

cd typescript
npm test
npm run typecheck
npm run build
npm pack --dry-run
Repository hygiene checks: 
npm run format:check
git diff --check
Use npm run format from the repo root to format Markdown, JSON, YAML, and TypeScript files when needed.

​
Pull requests

  • Open normal pull requests against develop.
  • Keep the change focused on one problem or feature.
  • Use Conventional Commit wording for PR titles.
  • Update docs and examples when public behavior changes.
  • Add or update tests for user-facing behavior and non-trivial logic.
  • Include the exact verification commands you ran.

​
Security

Report security issues by email to security@viscribe.ai. Do not open public issues for security-sensitive reports.