Neuracore Types

Shared type definitions for the Neuracore platform. This package maintains a single source of truth for data types in Python (Pydantic models) and automatically generates TypeScript types.

Overview

  • Python Package: neuracore-types - Pydantic models for Python backend
  • NPM Package: @neuracore/types - TypeScript types for frontend

Installation

Python

pip install neuracore-types

TypeScript/JavaScript

npm install @neuracore/types
# or
yarn add @neuracore/types
# or
pnpm add @neuracore/types

To track unreleased types from main (used by staging deploys and tests), install the main dist-tag instead. It is republished on every push to main that changes the generated types:

npm install @neuracore/types@main

Development

Setup

# Clone the repository
git clone https://github.com/neuracoreai/neuracore_types.git
cd neuracore_types

# Install Python dependencies
pip install -e ".[dev]"

# Install Node dependencies
npm install

Generate TypeScript Types

The TypeScript types are automatically generated from the Python Pydantic models:

npm install json-schema-to-typescript
python scripts/generate_types.py

This will:

  1. Read the Pydantic models from neuracore_types/neuracore_types.py
  2. Generate TypeScript definitions in typescript/neuracore_types.ts
  3. Create an index file at typescript/index.ts

Build TypeScript Package

npm run build

This compiles the TypeScript files to JavaScript and generates type declarations in the dist/ directory.

Release Process

Creating PRs

All PRs must follow these conventions:

  1. Version Label: Add exactly one version label to your PR:

    • version:major - Breaking changes
    • version:minor - New features
    • version:patch - Bug fixes
    • version:none - No release (docs, chores, etc.)

  2. Commit Format: PR title and all commits must use conventional commit format:

    <prefix>: <description>

    Valid prefixes: feat, fix, chore, docs, ci, test, refactor, style, perf

    Examples:

    • feat: add new data type for robot state
    • fix: resolve serialization issue in TypeScript types
    • chore: update dependencies

Pending Changelog

For significant changes (version:major or version:minor), update changelogs/pending-changelog.md:

## Summary

This release adds support for new sensor data types and improves TypeScript type generation.

Simply append your summary to the existing content. This will appear at the top of the release notes.

Triggering a Release

Releases are manual and triggered via GitHub Actions:

  1. Go to Actions → Release → Run workflow
  2. Optional: Check dry_run to preview without publishing
  3. The workflow will:
    • Analyze all PRs since last release
    • Determine version bump (highest priority across all PRs)
    • Generate changelog with all PRs grouped by type
    • Bump version in pyproject.toml, package.json, and __init__.py
    • Generate TypeScript types from Python models
    • Publish Python package to PyPI
    • Build and publish npm package to npm registry
    • Create GitHub release

Dry run shows what would happen without making any changes - useful for testing before a real release.

CI/CD

The repository includes GitHub Actions workflows:

  1. PR Checks:

    • Validates version labels
    • Enforces conventional commit format
    • Runs pre-commit hooks
    • Suggests changelog updates for major/minor changes

  2. Release (manual trigger):

    • Generates TypeScript types from Python models
    • Builds and validates both packages
    • Publishes to PyPI and npm registry
    • Creates GitHub release with changelog

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (11.10.0)

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: Neuracore

License

MIT

Requires

Python >=3.10

Provides Extra

dev ml

Report project as malware

Download files

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

Source Distribution

neuracore_types-10.6.0.tar.gz (83.9 kB view details)

Uploaded Source

Built Distribution

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

neuracore_types-10.6.0-py3-none-any.whl (74.6 kB view details)

Uploaded Python 3

File details

Details for the file neuracore_types-10.6.0.tar.gz.

File metadata

  • Download URL: neuracore_types-10.6.0.tar.gz
  • Upload date:
  • Size: 83.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for neuracore_types-10.6.0.tar.gz
Algorithm Hash digest
SHA256 929407b099f6ed0380348044e8446cf3ec36e44bebcc1890074f84344ab6383c
MD5 be1d8a2692f5c13640e2f2bfc5648b70
BLAKE2b-256 a62346b3e0d9a6dc34851931937819742826f0e19f24f6b0e1f5179b02d02e28

See more details on using hashes here.

File details

Details for the file neuracore_types-10.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for neuracore_types-10.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cebef3d4aebe606cd8ec3b69f18fc70b0cf798b3e401cf43d74ec6bc962d4b2e
MD5 f56692f59b7e42d71cb8429aa4a6e287
BLAKE2b-256 2c0239ee3cc8995f51602dc443e4b4827d94f410fd069beb58d52c4eaa020848

See more details on using hashes here.

Release history Release notifications | RSS feed

11.10.0

2 files

11.9.0

2 files

11.8.0

2 files

11.7.0

2 files

11.6.0

2 files

11.5.0

2 files

11.4.0

2 files

11.3.0

2 files

11.2.0

2 files

11.1.0

2 files

11.0.0

2 files

This release

10.6.0 This release

2 files

10.5.0

2 files

10.4.0

2 files

10.3.0

2 files

10.2.0

2 files

10.1.0

2 files

10.0.0

2 files

9.0.0

2 files

8.0.0

2 files

7.5.0

2 files

7.4.0

2 files

7.3.0

2 files

7.2.0

2 files

7.1.0

2 files

7.0.0

2 files

6.13.0

2 files

6.12.1

2 files

6.12.0

2 files

6.11.0

2 files

6.10.0

2 files

6.9.0

2 files

6.8.0

2 files

6.7.0

2 files

6.6.1

2 files

6.6.0

2 files

6.5.1

2 files

6.5.0

2 files

6.4.0

2 files

6.3.0

2 files

6.2.1

2 files

6.2.0

2 files

6.1.0

2 files

6.0.1

2 files

6.0.0

2 files

5.0.0

2 files

4.6.0

2 files

4.5.0

2 files

4.4.1

2 files

4.4.0

2 files

4.3.0

2 files

4.2.0

2 files

4.1.1

2 files

4.1.0

2 files

4.0.0

2 files

3.0.0

2 files

2.0.0

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.1

2 files

1.3.0

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page