https://github.com/manuelbcd/go-openproject

Go client library for OpenProject
https://github.com/manuelbcd/go-openproject

Last synced: about 1 month ago
JSON representation

Go client library for OpenProject

• Host: GitHub
• URL: https://github.com/manuelbcd/go-openproject
• Owner: manuelbcd
• License: mit
• Created: 2021-02-13T23:23:13.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-22T09:30:01.000Z (about 2 years ago)
• Last Synced: 2024-07-31T20:53:19.928Z (5 months ago)
• Language: Go
• Size: 5.07 MB
• Stars: 16
• Watchers: 4
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go - go-openproject - Go client library for interacting with [OpenProject](https://docs.openproject.org/api/) API. (Third-party APIs / Utility/Miscellaneous)
• awesome-go-extra - go-openproject - 02-13T23:23:13Z|2021-04-09T08:39:38Z| (Third-party APIs / Fail injection)

README

        
# OpenProject Go Client Library

[![codecov](https://codecov.io/gh/manuelbcd/go-openproject/branch/master/graph/badge.svg?token=C945C180MG)](https://codecov.io/gh/manuelbcd/go-openproject)

[![Go Report Card](https://goreportcard.com/badge/github.com/manuelbcd/go-openproject)](https://goreportcard.com/report/github.com/manuelbcd/go-openproject)

[![Go Reference](https://pkg.go.dev/badge/github.com/manuelbcd/go-openproject.svg)](https://pkg.go.dev/github.com/manuelbcd/go-openproject)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[Go](https://golang.org/) client library for [OpenProject](https://www.openproject.org)

![Openproject client library written in Go](./go-openproject.png)

## API doc

https://docs.openproject.org/api

## Usage examples

### Single work-package request

Basic work-package retrieval (Single work-package with ID 36353 from community.openproject.org)

Please check [examples](https://github.com/manuelbcd/go-openproject/tree/master/examples) folder for different use-cases.

```go

import (

	"fmt"

	openproj "github.com/manuelbcd/go-openproject"

)

func main() {

	client, _ := openproj.NewClient(nil, "https://community.openproject.org/")

	wpResponse, _, err := client.WorkPackage.Get("36353", nil)

	if err != nil {

		panic(err)

	}

	// Output specific fields from response

	fmt.Printf("\n\nSubject: %s \nDescription: %s\n\n", wpResponse.Subject, wpResponse.Description.Raw)

}

```

### Create a work package

Create a single work package

```go

package main

import (

	"fmt"

	"strings"

	openproj "github.com/manuelbcd/go-openproject"

)

func main() {

	client, err := openproj.NewClient(nil, "https://youropenproject.url")

	if err != nil {

		fmt.Printf("\nerror: %v\n", err)

		return

	}

	i := openproj.WorkPackage{

		Subject: "This is my test work package",

		Description: &openproj.WPDescription{

			Format: "textile",

			Raw:    "This is just a demo workpackage description",

		},

	}

	wpResponse, _, err := client.WorkPackage.Create(&i, "demo-project")

	if err != nil {

		panic(err)

	}

	// Output specific fields from response

	fmt.Printf("\n\nSubject: %s \nDescription: %s\n\n", wpResponse.Subject, wpResponse.Description.Raw)

}

```

## Supported objects

| Endpoint               | GET single | GET many | POST | PUT | DELETE |

|------------------------| :-------------: | :-------------: | :-------------: | :-------------: | :-------------: |

| Attachments (Info)     | :heavy_check_mark: | :heavy_check_mark: | *implementing* | - | *pending* |

| Attachments (Download) | :heavy_check_mark: | - | - | - | - |

| Categories             | :heavy_check_mark: | :heavy_check_mark: | - | - | - |

| Documents              | *implementing* | - | - | - | - |

| Projects               | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | *pending* | *pending* | *pending* |

| Queries                | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |

| Schemas                | *pending* |

| Statuses               | :heavy_check_mark: | :heavy_check_mark: | *pending* | *pending* | *pending* |

| Users                  | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: |

| Wiki Pages             | :heavy_check_mark: | *pending* | *pending* | *pending* | *pending* |

| WorkPackages           | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | 

| Activities             | :heavy_check_mark: | :heavy_check_mark: |  | | | 

## Thanks

Thanks [Wieland](https://github.com/wielinde), [Oliver](https://github.com/oliverguenther) and [OpenProject](https://github.com/opf/openproject) team for your support.

Thank you very much [Andy Grunwald](https://github.com/andygrunwald) for the idea and your base code.

Inspired in [Go Jira library](https://github.com/andygrunwald/go-jira)