Skip to main content

Add your description here

Project description

ganglion

The server that serves Textual apps in the browser.

Currently an early WIP

Getting Started

Ganglion doesn't use any particular packaging ATM. Here's how to install:

  • Create and activate a Python 3.11 venv:
  • pip install -r requirements.txt
  • pip install -e .

This will install a ganglion command on the path.

Install the front-end dependencies using npm i. If you don't have npm, consider using nvm (or nvm.fish) to install it. You can install the latest node and npm using nvm install latest.

To test, open 2 terminals, and activate the venvs.

On terminal A, run DEBUG=1 ganglion serve. On terminal B, run DEBUG=1 ganglion client.

If all goes well you should be able to type in terminal B, and see the packets arrive on terminal A.

Setting up a database for local development

MacOS

  • Install Postgres.app.
  • Add /Applications/Postgres.app/Contents/Versions/latest/bin to your PATH.
  • Run psql in your terminal, then run CREATE DATABASE ganglion; to create the required database.
  • Leave psql (ctrl+d), and run alembic upgrade head to set up the initial database.
  • Re-enter psql and run \c ganglion to connect to the ganglion database.
  • Run \dt to list all the tables in the current database - you should see that tables have been created.

Migrations

Create migration file:

alembic revision --autogenerate -m "Added account table"

Apply migration:

alembic upgrade head

See Alembic docs for details

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

ganglion-0.1.0.tar.gz (345.0 kB view details)

Uploaded Source

Built Distribution

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

ganglion-0.1.0-py3-none-any.whl (94.7 kB view details)

Uploaded Python 3

File details

Details for the file ganglion-0.1.0.tar.gz.

File metadata

  • Download URL: ganglion-0.1.0.tar.gz
  • Upload date:
  • Size: 345.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for ganglion-0.1.0.tar.gz
Algorithm Hash digest
SHA256 02348f14838e9593593c6952d14c4a4acedf4b9eb4e350f5cc5108cdc2ba112e
MD5 8dc17dda7cf2f2d20700ca4ace4f6c44
BLAKE2b-256 7c8488afcbdc4578b06f1626de73f73265bfae72db903664ee79057011e4bf7a

See more details on using hashes here.

File details

Details for the file ganglion-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ganglion-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 94.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for ganglion-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9239b25da82f3742e5943f837c174b769b13658d50238569743db269e44974ab
MD5 3a6b34bd5968faf3e00c70fd08a1830a
BLAKE2b-256 15bd4c1da041574f72c126cdd1c4b4ad6cb88486a47130ceac8420e424a027ce

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