Skip to main content

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

Project description

exobrain-actions-schemas

CI 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.1.0.post1.tar.gz (40.9 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file exobrain_actions_schemas-0.1.0.post1.tar.gz.

File metadata

File hashes

Hashes for exobrain_actions_schemas-0.1.0.post1.tar.gz
Algorithm Hash digest
SHA256 226eebac7179642a0e501f643da4e06bdbcadc1a53facfdfe0fcc4bf7caa240c
MD5 c89f06b2f078bdba1ca4363c142b3521
BLAKE2b-256 69d73a0fd3c1a9522af5e1eac09fbcdc81dea815fb4602c75ee2edce7bcad1b3

See more details on using hashes here.

File details

Details for the file exobrain_actions_schemas-0.1.0.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for exobrain_actions_schemas-0.1.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 665ec9c9c11b5fb3e5fcb554c535b450c0d93ce140d90613bec73c4899c487b7
MD5 735bfa6186c99339f90b5b36407d0f43
BLAKE2b-256 953803a0aa63842a5834ef20137c449af1fff7bbdd627345857fd94b43380c85

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