https://github.com/cryptix/gopshdlrest

A standalone package for the PSHDL REST API
https://github.com/cryptix/gopshdlrest

Last synced: 12 months ago
JSON representation

A standalone package for the PSHDL REST API

• Host: GitHub
• URL: https://github.com/cryptix/gopshdlrest
• Owner: cryptix
• License: mit
• Created: 2014-05-08T18:12:52.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2014-10-15T16:22:08.000Z (over 11 years ago)
• Last Synced: 2025-02-02T10:21:53.446Z (over 1 year ago)
• Language: Go
• Size: 363 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
goPshdlRest

===========

[![Build Status](https://travis-ci.org/cryptix/goPshdlRest.png?branch=master)](https://travis-ci.org/cryptix/goPshdlRest)

This package provides access to the [PSHDL](http://pshdl.org) REST API.

## Features

* Create new and open existing Workspaces

* Upload/Download/Delete files to Workspaces

* Get Events of Workspace changes through the StreamingService

## Clients

There are currently two clients in the `cmd` folder.

`pshdlSync` is used to push local changes to the remote api.

It's only one-way currently. Check out [localhelper](http://code.pshdl.org/pshdl.localhelper/wiki/Home) if you want two-way.

`pshdlCompilat` watches a workspace for Events and downloads generated code

Currently VHDL and C but the others would be simple to add.

## Documentation

Checkout [godoc.org](http://godoc.org/github.com/cryptix/goPshdlRest/api).

It's not 100% complete but I'm working on it.

## TODO

* turn service into resources that contain a client

* More Tests!

* More Documentation!

* Add Validate() and RequestSimCode() to clients

* Write a client that retreives pshdl errors to integrate with editors.

* Api inconsistancys

    - as json request

        - Workspace Create

        - Upload?