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. No latency. No 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.

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, num2):
    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 same details.

And, want to say something to the frontend?

await ephaptic.to(user1, user2).notification("Hello, world!", priority="high")
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') } })

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.1.2.tar.gz (15.1 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.1.2-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ephaptic-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ef5c0ab8d1238438fe2ed86c715773ba963716d8261a2cd6d9e496cd4607a220
MD5 a831782e1da04b76c9cae64c7ee9aedc
BLAKE2b-256 f931d1421228a19a3c267fa8d3dc9865be94f6865d33870a44f4cc35f2395f0b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ephaptic-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 76e0d780c0248ee8d4fd40db9859579708802a29802d773ce61ca5e9f1ce352a
MD5 4152f9487b8e3e180cb1c22b9f445134
BLAKE2b-256 60a4c9a4992cd14c43135e54f5e2160bb48c65db8eca9167d667ba1784f330fd

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