Skip to main content

SpeedAPI schema compiler

Project description

License Version Downloads PRs and issues

SUS compiler

This repository contains the compiler and language server for the SUS description language. Install it with:

pip3 install susc

What is SpeedAPI?

It's a platform-agnostic API and serialization tool specifically geared towards high-throughput realtime applications. You can read more about its features here

Usage

Help

$ susc --help
# OR
$ python3 -m susc --help

Compiler

  • Compile file(s): susc source1.sus source2.sus
  • Compile file, override output dir: susc -o output source.sus
  • Compile file, override output language: susc -l ts source.sus

Language server

  • Start language server: susc -s
  • Start language server in stdio mode: susc -si

Misc

  • Print file with syntax highlighting: susc -p source.sus
  • Explain a diagnostic code: susc -x 0010

Programmatic usage

from susc import File

file = File()
# load file:
file.load_from_file("/path/to/file.sus")
# or
file.load_from_file(open("/path/to/file.sus"))
# or load text:
file.load_from_text("compound Test { a: Str; b: Str; }")

things, diagnostics = file.parse()
print(things)
print(diagnostics)

language = "ts"
file.write_output(language, "/path/to/output/dir")

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

susc-1.5.5.tar.gz (163.6 kB view details)

Uploaded Source

Built Distribution

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

susc-1.5.5-py3-none-any.whl (165.0 kB view details)

Uploaded Python 3

File details

Details for the file susc-1.5.5.tar.gz.

File metadata

  • Download URL: susc-1.5.5.tar.gz
  • Upload date:
  • Size: 163.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for susc-1.5.5.tar.gz
Algorithm Hash digest
SHA256 d2623d4222424e2cdd0249ade3db849b7a778c4a56555f68e6a2d63034a460fa
MD5 7891d4fa0133a456e4d8bf52ab4c7798
BLAKE2b-256 40c128b19c7f6859e73b0ffec5d7a3ddffd8ad941bbc8f0e1cf5d5be4c001793

See more details on using hashes here.

File details

Details for the file susc-1.5.5-py3-none-any.whl.

File metadata

  • Download URL: susc-1.5.5-py3-none-any.whl
  • Upload date:
  • Size: 165.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for susc-1.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e9c894372f16a9a14b0f82aba9d8be8ed2c83e940574ad2806f28ac4c6bf0de0
MD5 6aede6ccb27bfedbc714ef1d56939ce5
BLAKE2b-256 d7ee49a51be9a74056282e00ebdd47fc53bdb93a6a2235d76d3ba9f6f5b9feab

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