neuracore-types 1.0.0__tar.gz

neuracore_types-1.0.0/.bumpversion.cfg

@@ -0,0 +1,18 @@
+[bumpversion]
+current_version = 1.0.0
+commit = True
+tag = True
+tag_name = v{new_version}
+message = Bump version to {new_version} [skip ci]
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:package.json]
+search = "version": "{current_version}"
+replace = "version": "{new_version}"
+
+[bumpversion:file:neuracore_types/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

neuracore_types-1.0.0/.github/workflows/check-label.yaml

@@ -0,0 +1,39 @@
+name: Check Label
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check-version-label:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Check for version label
+      uses: actions/github-script@v7
+      with:
+        script: |
+          const pr = context.payload.pull_request;
+          const labels = pr.labels.map(label => label.name);
+          
+          console.log('PR Labels:', labels);
+          
+          // Define valid version labels
+          const versionLabels = [
+            'version:major',
+            'version:minor', 
+            'version:patch',
+            'version:none'
+          ];
+
+          // Check for only one and return success or fail
+          const versionLabelCount = labels.filter(label => versionLabels.includes(label)).length;
+
+          if (versionLabelCount === 0) {
+            core.setFailed('PR is missing a version label. Please add one of: version:major, version:minor, version:patch, or version:none');
+          } else if (versionLabelCount > 1) {
+            core.setFailed('PR has multiple version labels. Please keep only one: version:major, version:minor, version:patch, or version:none');
+          } else {
+            console.log('✅ PR has a valid version label:', labels.filter(l => versionLabels.includes(l)));
+          }

neuracore_types-1.0.0/.github/workflows/generate-and-publish.yaml

@@ -0,0 +1,267 @@
+name: Generate Types and Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  generate-types:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        registry-url: 'https://registry.npmjs.org'
+    
+    - name: Install Python dependencies
+      run: |
+        pip install --upgrade pip
+        pip install -e ".[dev]"
+    
+    - name: Install Node dependencies
+      run: npm install
+    
+    - name: Generate TypeScript types
+      run: python scripts/generate_types.py
+    
+    - name: Build TypeScript
+      run: npm run build
+    
+    - name: Upload TypeScript artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: typescript-types
+        path: dist/
+
+  check-version-bump:
+    needs: generate-types
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    permissions:
+      contents: read
+      pull-requests: read
+    outputs:
+      should_release: ${{ steps.check.outputs.should_release }}
+      bump_type: ${{ steps.check.outputs.bump_type }}
+      pr_number: ${{ steps.check.outputs.pr_number }}
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    
+    - name: Get merged PR labels
+      id: pr_labels
+      uses: actions/github-script@v7
+      with:
+        script: |
+          const commit = context.sha;
+          
+          // Find the PR associated with this merge commit
+          const prs = await github.rest.repos.listPullRequestsAssociatedWithCommit({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            commit_sha: commit
+          });
+          
+          if (prs.data.length === 0) {
+            console.log('No PR found for this commit');
+            return { bump_type: 'none' };
+          }
+
+          // Define valid version labels
+          const versionLabels = [
+            'version:major',
+            'version:minor', 
+            'version:patch',
+            'version:none'
+          ];
+          
+          const pr = prs.data[0];
+          const firstLabel = pr.labels[0]?.name;
+          let bump_type = firstLabel.split(':')[1];
+          return { bump_type, pr_number: pr.number };
+    
+    - name: Check if release needed
+      id: check
+      run: |
+        BUMP_TYPE="${{ fromJSON(steps.pr_labels.outputs.result).bump_type }}"
+        PR_NUMBER="${{ fromJSON(steps.pr_labels.outputs.result).pr_number }}"
+        
+        if [ "$BUMP_TYPE" = "none" ] || [ -z "$BUMP_TYPE" ]; then
+          echo "No version bump label found - skipping release"
+          echo "should_release=false" >> $GITHUB_OUTPUT
+          echo "bump_type=none" >> $GITHUB_OUTPUT
+        else
+          echo "Version bump type: $BUMP_TYPE"
+          echo "should_release=true" >> $GITHUB_OUTPUT
+          echo "bump_type=$BUMP_TYPE" >> $GITHUB_OUTPUT
+          echo "pr_number=$PR_NUMBER" >> $GITHUB_OUTPUT
+        fi
+
+  version-bump:
+    needs: check-version-bump
+    runs-on: ubuntu-latest
+    if: needs.check-version-bump.outputs.should_release == 'true'
+    permissions:
+      contents: write
+      pull-requests: read
+    outputs:
+      new_version: ${{ steps.bump.outputs.new_version }}
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+    
+    - name: Install dependencies
+      run: |
+        pip install bump2version
+        npm install -g json
+    
+    - name: Bump version
+      id: bump
+      run: |
+        BUMP_TYPE="${{ needs.check-version-bump.outputs.bump_type }}"
+        
+        echo "Bumping $BUMP_TYPE version"
+
+        # Configure git
+        git config user.email "github-actions[bot]@users.noreply.github.com"
+        git config user.name "github-actions[bot]"
+        
+        # Use bump2version to bump the version
+        bump2version $BUMP_TYPE --allow-dirty
+        NEW_VERSION=$(grep -m 1 'version = ' pyproject.toml | cut -d'"' -f2)
+        
+        echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
+                
+        git push origin main --tags
+
+  publish-python:
+    needs: version-bump
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        ref: main
+        fetch-depth: 0
+    
+    - name: Pull latest changes
+      run: |
+        git pull --tags
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install build tools
+      run: |
+        pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build Python package
+      run: python -m build
+    
+    - name: Publish to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: twine upload dist/*
+
+  publish-npm:
+    needs: [version-bump, generate-types]
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        ref: main
+        fetch-depth: 0
+    
+    - name: Pull latest changes
+      run: |
+        git pull --tags
+    
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        registry-url: 'https://registry.npmjs.org'
+    
+    - name: Download TypeScript artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: typescript-types
+        path: dist/
+    
+    - name: Publish to NPM
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      run: npm publish
+
+  create-release:
+    needs: [version-bump, publish-python, publish-npm]
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        ref: main
+        fetch-depth: 0
+    
+    - name: Pull latest changes
+      run: |
+        git pull --tags
+    
+    - name: Create GitHub Release
+      uses: actions/github-script@v7
+      with:
+        script: |
+          const version = '${{ needs.version-bump.outputs.new_version }}';
+          
+          await github.rest.repos.createRelease({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            tag_name: `v${version}`,
+            name: `Release v${version}`,
+            body: `## Release v${version}\n\n` +
+                  `Published to:\n` +
+                  `- PyPI: https://pypi.org/project/neuracore-types/${version}/\n` +
+                  `- NPM: https://www.npmjs.com/package/@neuracore/types/v/${version}\n\n` +
+                  `### Installation\n` +
+                  `\`\`\`bash\n` +
+                  `pip install neuracore-types==${version}\n` +
+                  `npm install @neuracore/types@${version}\n` +
+                  `\`\`\``,
+            draft: false,
+            prerelease: false
+          });

neuracore_types-1.0.0/.github/workflows/pre-commit.yaml

@@ -0,0 +1,41 @@
+name: Pre-Commit Checks
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ github.event.inputs.ref || github.ref }}
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - name: Pre-Commit
+      uses: pre-commit/action@v3.0.1
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        registry-url: 'https://registry.npmjs.org'
+    
+    - name: Install Python dependencies
+      run: |
+        pip install --upgrade pip
+        pip install -e ".[dev]"
+    
+    - name: Install Node dependencies
+      run: npm install
+    
+    - name: Valide that we can generate TypeScript types
+      run: python scripts/generate_types.py

neuracore_types-1.0.0/.gitignore

@@ -0,0 +1,55 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.venv
+venv/
+ENV/
+env/
+
+# Node
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# TypeScript
+dist/
+*.tsbuildinfo
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Generated files
+typescript/neuracore_types.ts
+typescript/index.ts

neuracore_types-1.0.0/.npmignore

@@ -0,0 +1,20 @@
+# Source files
+typescript/
+neuracore_types/
+scripts/
+
+# Python files
+*.py
+pyproject.toml
+MANIFEST.in
+
+# Config files
+tsconfig.json
+.github/
+
+# Development
+node_modules/
+*.log
+
+# Keep only dist
+!dist/

neuracore_types-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+default_install_hook_types: [pre-commit]
+default_stages: [commit]
+
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: ["--profile", "black", "--filter-files"]
+
+  - repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+      - id: black
+        language_version: python3
+        args: [--line-length=88, --preview]
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.272
+    hooks:
+      - id: ruff
+        # Ignoring unused imports within __init__.py files.
+        args: [--per-file-ignores, "*__init__.py:F401", --fix]
+
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0
+    hooks:
+      - id: pydocstyle
+        files: neuracore_types/
+        args: ["--convention=google"]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: ""
+    hooks:
+      - id: mypy
+        files: neuracore_types/
+        args: ["--disallow-untyped-defs", "--ignore-missing-imports"]
+        additional_dependencies: [types-requests]
+        
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v9.2.0
+    hooks:
+      - id: cspell # Spell check changed files
+      - id: cspell # Spell check the commit message
+        name: check commit message spelling
+        args:
+          - --no-must-find-files
+          - --no-progress
+          - --no-summary
+          - --files
+          - .git/COMMIT_EDITMSG
+        stages: [commit-msg]
+        always_run: true

neuracore_types-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Neuracore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

neuracore_types-1.0.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: neuracore-types
+Version: 1.0.0
+Summary: Shared type definitions for Neuracore.
+Author: Neuracore
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pydantic-to-typescript2>=1.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# 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
+
+```bash
+pip install neuracore-types
+```
+
+### TypeScript/JavaScript
+
+```bash
+npm install @neuracore/types
+# or
+yarn add @neuracore/types
+# or
+pnpm add @neuracore/types
+```
+
+## Development
+
+### Setup
+
+```bash
+# 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:
+
+```bash
+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
+
+```bash
+npm run build
+```
+
+This compiles the TypeScript files to JavaScript and generates type declarations in the `dist/` directory.
+
+## CI/CD
+
+The repository includes GitHub Actions workflows that:
+
+1. **On every push to `main` or PR**:
+   - Automatically generates TypeScript types from Python models
+   - Builds and validates both packages
+   - Publishes Python package to PyPI
+   - Publishes NPM package to npm registry

neuracore_types-1.0.0/README.md

@@ -0,0 +1,74 @@
+# 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
+
+```bash
+pip install neuracore-types
+```
+
+### TypeScript/JavaScript
+
+```bash
+npm install @neuracore/types
+# or
+yarn add @neuracore/types
+# or
+pnpm add @neuracore/types
+```
+
+## Development
+
+### Setup
+
+```bash
+# 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:
+
+```bash
+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
+
+```bash
+npm run build
+```
+
+This compiles the TypeScript files to JavaScript and generates type declarations in the `dist/` directory.
+
+## CI/CD
+
+The repository includes GitHub Actions workflows that:
+
+1. **On every push to `main` or PR**:
+   - Automatically generates TypeScript types from Python models
+   - Builds and validates both packages
+   - Publishes Python package to PyPI
+   - Publishes NPM package to npm registry

neuracore_types-1.0.0/cSpell.json

@@ -0,0 +1,22 @@
+{
+    "ignorePaths": [
+        "cSpell.json",
+        ".*",
+        "*.Dockerfile",
+        "docker-compose.yml",
+        "requirements*.txt",
+        "*.sh"
+    ],
+    "dictionaryDefinitions": [
+        {
+            "name": "neuracore-dictionary",
+            "path": "./neuracore-dictionary.txt",
+            "addWords": true
+        }
+    ],
+    "language": "en,en-GB",
+    "dictionaries": [
+        "neuracore-dictionary"
+    ],
+    "words": []
+}