Skip to main content

Pydantic models for Exobrain Actions management (REST API clients or FastAPI/Flask web services)

Project description

exobrain-actions-schemas

License: Private Python 3.12+

Pydantic models for Exobrain Actions management.

This package provides Pydantic models for managing Exobrain Actions schemas. It is designed to be used as a dependency in REST API clients, web services built with FastAPI or Flask, or any other Python application that requires strict data validation and serialization for Exobrain Actions management.

Key features:

  • Typed data models for Exobrain Actions
  • Support for modern Pydantic (>=2.11.7, <3)
  • Can be integrated into server or client-side projects

Development workflow

Prerequisites

Before starting development, make sure you have the following tools installed:

  • Hatch: a modern Python project, environment, and packaging manager.

  • uv: a fast Python package installer and resolver.

Project Structure

  • Code: Place your models in exobrain/actions/schemas/.
  • Tests: Add your tests in tests/.

Development Commands

All tasks (testing, linting, type checking, packaging, etc.) are managed via hatch environments and scripts:

1. Installing Dependencies

Install all dependencies (including development tools):

hatch env create

2. Running Tests

Launch all tests using pytest:

hatch test

3. Linting and Formatting

Format your code:

hatch fmt -f

Check code style:

hatch fmt

4. Type Checking

Run type checks with mypy:

hatch run types:check

5. Coverage

Check test coverage with:

hatch test --cover

6. Building the Package

Build the package for distribution:

hatch build

7. Releasing

The release process uses uv and Github Actions.

  • For pre-release on TestPyPI: push a tag with rc or beta in the version (0.1rc1, 0.2b1 etc.).
  • For release: push a tag type v0.1 (main release) on main branch.
  • Configure secrets for PyPI tokens in repository settings (PYPI_TOKEN, TEST_PYPI_TOKEN).

Continuous Integration

All pushes and pull requests on main or development branches trigger the Continuous Integration pipeline
(see .github/workflows/ directory for details).


License

This project is private and confidential.

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

exobrain_actions_schemas-0.3.1.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

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

exobrain_actions_schemas-0.3.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file exobrain_actions_schemas-0.3.1.tar.gz.

File metadata

  • Download URL: exobrain_actions_schemas-0.3.1.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for exobrain_actions_schemas-0.3.1.tar.gz
Algorithm Hash digest
SHA256 a0ed5f1f832a2dc347d96b2bd8e55938610417c790dab72a04cc7fd93d038c6c
MD5 7d8208c16ff0d4bbebfee8430482c3d9
BLAKE2b-256 ba9cdbf0be172dea7af27d6c6ab0e1b93ea53056d7f18fd612be48699bcfc2d6

See more details on using hashes here.

File details

Details for the file exobrain_actions_schemas-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for exobrain_actions_schemas-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 efab6a13623c6cbd1facaf68396d8734e73052f3e41a311a0d7b625e4b31cc72
MD5 38efce8021d2949209bdc57d81e7d9b3
BLAKE2b-256 5c7955587f6751a8f1b8c6d2fca18c5a501a90b150cc1d0c91bc5de42bee5b45

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