Skip to main content

The Python client/server package for ephaptic.

Project description

ephaptic logo

ephaptic


GitHub License GitHub Actions Workflow Status GitHub Actions Workflow Status PyPI - Version NPM - Version

What is ephaptic?


ephaptic (adj.)
electrical conduction of a nerve impulse across an ephapse without the mediation of a neurotransmitter.

Nah, just kidding. It's an RPC framework.

ephaptic — Call your backend straight from your frontend. No JSON. Low latency. Invisible middleware.

Getting Started

  • Ephaptic is designed to be invisible. Write a function on the server, call it on the client. No extra boilerplate.

  • Plus, it's horizontally scalable with Redis (optional), and features extremely low latency thanks to msgpack.

  • Oh, and the client can also listen to events broadcasted by the server. No, like literally. You just need to add an eventListener. Did I mention? Events can be sent to specific targets, specific users - not just anyone online.

  • Saved the best for last: it's type-safe. Don't believe me? Try it out for yourself. Simply type hint return values and parameters on the backend, and watch those very Python types transform into interfaces and types on the TypeScript frontend. Plus, you can use Pydantic - which means, for those of you who are FastAPI users, this is going to be great.

What are you waiting for? Let's go.

Python

Client:

pip install ephaptic

Server:

pip install ephaptic[server]
from fastapi import FastAPI # or `from quart import Quart`
from ephaptic import Ephaptic

app = FastAPI() # or `app = Quart(__name__)`

ephaptic = Ephaptic.from_app(app) # Finds which framework you're using, and creates an ephaptic server.

You can also specify a custom path:

ephaptic = Ephaptic.from_app(app, path="/websocket")

And you can even use Redis for horizontal scaling!

ephaptic = Ephaptic.from_app(app, redis_url="redis://my-redis-container:6379/0")

Now, how do you expose your function to the frontend?

@ephaptic.expose
async def add(num1: int, num2: int) -> int:
    return num1 + num2

Yep, it's really that simple.

But what if your code throws an error? No sweat, it just throws up on the frontend, with the error name.

And, want to say something to the frontend?

await ephaptic.to(user1, user2).notification("Hello, world!", priority="high")

To create a schema of your RPC endpoints:

$ ephaptic src.app:app -o schema.json

Pydantic is entirely supported. It's validated for arguments, it's auto-serialized when you return a pydantic model, and your models receive type definitions in the schema.

JavaScript/TypeScript — Browser (Svelt, React, Angular, Vite, etc.)

To use with a framework / Vite:

$ npm install @ephaptic/client

Then:

import { connect } from "@ephaptic/client";

const client = connect(); // Defaults to `/_ephaptic`.

Or, you can use it with a custom URL:

const client = connect({ url: '/ws' });
const client = connect({ url: 'wss://my-backend.deployment/ephaptic' });

You can even send auth objects to the server for identity loading.

const client = connect({ url: '...', auth: { token: window.localStorage.getItem('jwtToken') } })

And you can load types, too.

$ npm i --save-dev @ephaptic/type-gen
$ npx @ephaptic/type-gen ./schema.json -o schema.d.ts
import { connect } from "@ephaptic/client";
import { type EphapticService } from './schema';

const client = connect(...) as unknown as EphapticService;

Or, to use in your browser:

<script type="module">
import { connect } from 'https://cdn.jsdelivr.net/npm/@ephaptic/client@latest/+esm';

const client = connect(...);
</script>

License


© ephaptic 2025

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

ephaptic-0.2.0.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

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

ephaptic-0.2.0-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file ephaptic-0.2.0.tar.gz.

File metadata

  • Download URL: ephaptic-0.2.0.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for ephaptic-0.2.0.tar.gz
Algorithm Hash digest
SHA256 27ed649ad39b5f33db82c4e6817a4f0863973bb5f77815a69538ee69806acf04
MD5 980928839c84a4ad1b544b9b4f46011e
BLAKE2b-256 ffbb27ebe7db5920e2efdd65db46005e27c3ba726e391db6b556e4a98e4c9f5e

See more details on using hashes here.

File details

Details for the file ephaptic-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: ephaptic-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for ephaptic-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9696139fd877dc0262f3d098cb53386e34b7d7507790bf6e545c04b0bcccdea1
MD5 0792d2560955767b95e6f2e629751624
BLAKE2b-256 96d85e520613a0c0b279a67e379c3f3b269735fa3fe9ebf58399c5982c1c67ac

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