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.1.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.1-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ephaptic-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2c828d939dfde0dd55ca27ed24a0619e3cc9b4319122c22e8859680a6287d13e
MD5 ec194f4d3646884676cdb69e1ad18b66
BLAKE2b-256 c481a48ed13c87a6c8bdc4a981caedc2ffa12641e54790d12d9089bdfbea5c4c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ephaptic-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 df570c1befc4184c3fa4ce484ca43dc204ebce8f16426622b9228d28273ed2c0
MD5 6a9ea5c90558594ba865923ee91fb01a
BLAKE2b-256 e899190bc355b0b2971363cd9c58b1effeb33cecf7d2d1725227c4317eee38c4

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