{"id":28042328,"url":"https://github.com/parallaxsecond/parsec-client-go","last_synced_at":"2025-05-11T14:26:12.336Z","repository":{"id":36490494,"uuid":"210623102","full_name":"parallaxsecond/parsec-client-go","owner":"parallaxsecond","description":"Parsec Go client","archived":false,"fork":false,"pushed_at":"2022-10-25T09:54:42.000Z","size":405,"stargazers_count":12,"open_issues_count":20,"forks_count":5,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-07T13:52:00.280Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/parallaxsecond.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-24T14:27:41.000Z","updated_at":"2024-04-15T07:37:24.000Z","dependencies_parsed_at":"2023-01-17T02:00:22.333Z","dependency_job_id":null,"html_url":"https://github.com/parallaxsecond/parsec-client-go","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallaxsecond%2Fparsec-client-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallaxsecond%2Fparsec-client-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallaxsecond%2Fparsec-client-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallaxsecond%2Fparsec-client-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/parallaxsecond","download_url":"https://codeload.github.com/parallaxsecond/parsec-client-go/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253578791,"owners_count":21930603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-11T14:26:11.795Z","updated_at":"2025-05-11T14:26:12.327Z","avatar_url":"https://github.com/parallaxsecond.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n  -- Copyright 2021 Contributors to the Parsec project.\n  -- SPDX-License-Identifier: Apache-2.0\n\n  --\n  -- Licensed under the Apache License, Version 2.0 (the \"License\"); you may\n  -- not use this file except in compliance with the License.\n  -- You may obtain a copy of the License at\n  --\n  -- http://www.apache.org/licenses/LICENSE-2.0\n  --\n  -- Unless required by applicable law or agreed to in writing, software\n  -- distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n  -- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n  -- See the License for the specific language governing permissions and\n  -- limitations under the License.\n---\u003e\n\n![PARSEC logo](./parsec-logo.png)\n# PARSEC Go Client\n\nThis repository contains a PARSEC Go Client library.\nThe library contains methods to communicate using the [wire protocol](https://parallaxsecond.github.io/parsec-book/parsec_client/wire_protocol.html).\n\n---\n:imp:**WARNING** \n\nThe current status of this interface is suitable only for review of the API.  It is a work in progress.  There are ommissions and testing is very minimal at this stage.\n\n---\n\n# Build Status\n[![Build and Test](https://github.com/parallaxsecond/parsec-client-go/actions/workflows/build.yaml/badge.svg)](https://github.com/parallaxsecond/parsec-client-go/actions/workflows/build.yaml)\n[![Continuous Integration](https://github.com/parallaxsecond/parsec-client-go/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/parallaxsecond/parsec-client-go/actions/workflows/ci-tests.yml)\n# Usage\n\nSample usage can be found in the end to end tests in the [e2etest folder](https://github.com/parallaxsecond/parsec-client-go/tree/master/e2etest)\n\n# Parsec Service Socket Configuration\n\nThis client will, connect to the parsec service on a URL defined using the PARSEC_SERVICE_ENDPOINT environment variable.  This URL must be for the unix scheme (no other schemes are supported at this time).\n\nIf the PARSEC_SERVICE_ENDPOINT environment variable is not set, then the default value of unix:/run/parsec/parsec.sock is used.\n\n\n# Parsec Interface Version\n\nThe parsec interface is defined in google protocol buffers .proto files, included in the [parsec operations](https://github.com/parallaxsecond/parsec-operations), which is included as a git submodule in the [interface/parsec-operations](https://github.com/parallaxsecond/parsec-client-go/tree/master/interface/parsec-operations) folder in this repository.  This submodule is currently pinned to parsec-operations v0.6.0\n\nThe protocol buffers files are used to [generate translation golang code](https://github.com/parallaxsecond/parsec-client-go/tree/master/interface/operations) which is checked into this repository to remove the requirement for developers *using* this library to install protoc.\n\n## Interface Generation\n\n### Prerequisites\nYou will need [protoc 3+ installed](https://grpc.io/docs/protoc-installation/) as well as gcc.\n\nYou will also need the [go plugin for protoc](https://grpc.io/docs/languages/go/quickstart/)\n\nOn ubuntu 20.04, the following will install the tools you need:\n```bash\n# protoc and gcc\napt-get install protoc build-essential\n# go plugin\ngo install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26\n```\n\n### Generation\n\nTo update the generated files, run the following in this folder (protoc and make required)\n\n```\nmake clean-protobuf\nmake protoc\nmake build\n```\n\n# Testing\n\nTo run unit tests:\n\n```\nmake test\n```\n\nTo run continuous integration tests (requires docker).  This will run up docker container that will run the parsec daemon and then run a series of end to end tests.  \n\n``` \nmake ci-test-all\n# can also be run using\n./e2etest/scripts/ci-all.sh\n```\n\nAll code for the end to end tests is in the [e2etest](https://github.com/parallaxsecond/parsec-client-go/tree/master/e2etest) folder.\n\nBlack box unit tests for folders are found in a test folder under the main package folder (e.g. for algorithm [parsec/algorithm/test](https://github.com/parallaxsecond/parsec-client-go/tree/master/parsec/algorithm/test))\n\nInternal tests for packages will be in the relevant package folders as required by go, and will be called xxx_internal_test.go\n\n# Folder Structure\n\n- **This folder** General files that must be at the top level - readmes, licence, lint configurations, etc.\n- [.github/workflows](https://github.com/parallaxsecond/parsec-client-go/tree/master/.github/workflows) Github Build CI action definitions - CI testing, build, unit test, static analysis...\n- [e2etest](https://github.com/parallaxsecond/parsec-client-go/tree/master/e2etest) End to End testing - Docker containers to fire up parsec and run end to end tests.  Also used in CI end to end testing.\n- [interface](https://github.com/parallaxsecond/parsec-client-go/tree/master/interface) The Google Protocol Buffers basic client for communicating with the parsec daemon.  This provides the underlying interface to parsec, but is not intended for client application use.\n- [parsec](https://github.com/parallaxsecond/parsec-client-go/tree/master/parsec) This is the public interface of the Parsec Go client.\n\n# License\n\nThe software is provided under Apache-2.0. Contributions to this project are accepted under the same license.\n\nThis project uses the following third party libraries:\n- golang.org/x/sys BSD-3-Clause\n- google.golang.org/protobuf BSD-3-Clause\n- github.com/sirupsen/logrus MIT\n\n\n# Contributing\n\nPlease check the [Contributing](CONTRIBUTING.md) to know more about the contribution process.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparallaxsecond%2Fparsec-client-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparallaxsecond%2Fparsec-client-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparallaxsecond%2Fparsec-client-go/lists"}