https://github.com/dmigwi/go-piparser
Golang implementation of the Politeia's proposals votes data parser tool.
https://github.com/dmigwi/go-piparser
decred git github golang parser-tool politeia
Last synced: about 1 month ago
JSON representation
Golang implementation of the Politeia's proposals votes data parser tool.
- Host: GitHub
- URL: https://github.com/dmigwi/go-piparser
- Owner: dmigwi
- License: isc
- Created: 2019-02-24T05:27:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-19T17:18:29.000Z (over 6 years ago)
- Last Synced: 2025-06-18T16:47:14.741Z (12 months ago)
- Topics: decred, git, github, golang, parser-tool, politeia
- Language: Go
- Homepage:
- Size: 171 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-piparser
[](https://travis-ci.org/dmigwi/go-piparser)
[](http://copyfree.org)
go-piparser is tool that parses [Politeia](https://proposals.decred.org) proposals votes data stored in github.
It adds a timestamp field obtained from the commit history. The tool makes use of the git commandline interface to clone
and query the politeia votes data. Github repository updates are fetched at intervals of 1hr after setting up the
environment. [politeia doc](https://docs.decred.org/advanced/navigating-politeia-data/#voting-and-comment-data)
Check out the full doc at [godoc.org](https://godoc.org/github.com/dmigwi/go-piparser/proposals) or code navigation on [sourcegraph.com](https://sourcegraph.com/github.com/dmigwi/go-piparser/-/blob/proposals/parser.go)
## Table of Contents
- [Requirement](#requirement)
- [Installation](#installation)
- [Import go-piparser](#import-go-piparser)
- [Initialize the Parser instance](#initialize-the-parser-instance)
- [Fetch the Proposal's Votes](#fetch-the-proposal's-votes)
- [Fetch new updates via a trigger channel](#fetch-new-updates-via-a-trigger-channel)
- [Full Sample Program](#full-sample-program)
- [Test Client](#test-client)
## Requirement
- git - The tool requires a functional git commandline installation.
To install git visit [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- A git version of `v1.5.1` released on [April 4th 2007](https://github.com/git/git/releases/tag/v1.5.1) or one after is needed.
- go - Golang installation is needed.
- go1.11 or one after is required.
## Installation
```bash
go get -u github.com/dmigwi/go-piparser/proposals
```
## Import go-piparser
```go
import "github.com/dmigwi/go-piparser/proposals"
```
## Initialize the Parser instance
```go
repoOwner := ""
repoName := ""
cloneDir := "/path/to/root/clone/directory"
parser, err := proposals.NewParser(repoOwner, repoName, cloneDir)
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
```
- `repoOwner` - defines the owner of the repository where the Politeia votes are to be queries from. If not set, it defaults to `decred-proposals`
- `repoName` - defines the name of the repository holding the Politeia votes. If not set, it defaults to `mainnet`.
- `cloneDir` - defines the directory where the said repository will be cloned into. If not set, a tmp folder is created and set.
## Fetch the Proposal's Votes
```go
// Decred Integration for IDAX Exchange Proposal token.
// https://proposals.decred.org/proposals/60adb9c0946482492889e85e9bce05c309665b3438dd85cb1a837df31fbf57fb
proposalToken := "60adb9c0946482492889e85e9bce05c309665b3438dd85cb1a837df31fbf57fb"
// ProposalHistory returns votes data only associated with the set proposal token.
data, err := parser.ProposalHistory(proposalToken)
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
...
```
## Fetch new updates via a signal channel
- The one hour interval at which the update signal is sent starts to count immediately
after the `proposals.NewParser(repoOwner, repoName, cloneDir)` is invoked.
```go
// Updates trigger signal is sent hourly after which retrieval of the newly
// fetched updates can commence.
proposalUpdatesSignal := parser.UpdateSignal()
for range proposalUpdatesSignal{
// set the since time value
since, err := time.Parse(time.RFC3339,"2019-03-05T00:59:18Z")
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
// Fetch the proposal updates since 2019-03-05T00:59:18Z.
data, err = parser.ProposalHistorySince(proposalToken, since)
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
}
```
## Full Sample Program
```go
package main
import (
"log"
"github.com/dmigwi/go-piparser/proposals"
)
func main() {
cloneDir := "/path/to/root/clone/directory"
// Set the Proposal token
proposalToken := "60adb9c0946482492889e85e9bce05c309665b3438dd85cb1a837df31fbf57fb"
// Create a new Parser instance
parser, err := proposals.NewParser("", "", cloneDir)
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
// Retrieve the proposal token's votes data.
data, err := parser.ProposalHistory(proposalToken)
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
...
// Retrieve proposal updates after they happen.
proposalUpdatesSignal := parser.UpdateSignal()
for range proposalUpdatesSignal{
// set the since time value
since, err := time.Parse(time.RFC3339,"2019-03-05T00:59:18Z")
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
// Fetch the proposal updates since 2019-03-05T00:59:18Z.
data, err = parser.ProposalHistorySince(proposalToken, since)
if err != nil {
log.Fatalf("unexpected error occured: %v", err)
}
...
}
}
```
## Test Client
Find a complete test go-piparser implementation [here](https://github.com/dmigwi/go-piparser/tree/master/testutil)