https://github.com/softprops/goji

a rust interface for jira
https://github.com/softprops/goji

jira jira-client rust-library

Last synced: about 1 year ago
JSON representation

a rust interface for jira

• Host: GitHub
• URL: https://github.com/softprops/goji
• Owner: softprops
• License: mit
• Created: 2016-01-26T06:03:12.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-09-11T15:26:47.000Z (almost 4 years ago)
• Last Synced: 2025-03-31T08:12:03.248Z (about 1 year ago)
• Topics: jira, jira-client, rust-library
• Language: Rust
• Homepage:
• Size: 737 KB
• Stars: 76
• Watchers: 2
• Forks: 43
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# goji [![Build Status](https://travis-ci.org/softprops/goji.svg?branch=master)](https://travis-ci.org/softprops/goji) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE) [![crates.io](http://meritbadge.herokuapp.com/goji)](https://crates.io/crates/goji) [![Released API docs](https://docs.rs/goji/badge.svg)](http://docs.rs/goji) [![Master API docs](https://img.shields.io/badge/docs-master-green.svg)](https://softprops.github.io/goji)

> a rust interface for [jira](https://www.atlassian.com/software/jira)

## install

Add the following to your `Cargo.toml` file

```toml

[dependencies]

goji = "0.2"

```

## usage

Please browse the [examples](examples/) directory in this repo for some example applications.

Basic usage requires a jira host, and a flavor of `jira::Credentials` for authorization. For user authenticated requests you'll typically want to use `jira::Credentials::Basic` with your jira username and password.

Current support api support is limited to search and issue transitioning.

```rust

extern crate env_logger;

extern crate goji;

use goji::{Credentials, Jira};

use std::env;

fn main() {

    drop(env_logger::init());

    if let (Ok(host), Ok(user), Ok(pass)) =

        (

            env::var("JIRA_HOST"),

            env::var("JIRA_USER"),

            env::var("JIRA_PASS"),

        )

    {

        let query = env::args().nth(1).unwrap_or("assignee=doug".to_owned());

        let jira = Jira::new(host, Credentials::Basic(user, pass)).unwrap();

        match jira.search().iter(query, &Default::default()) {

            Ok(results) => {

                for issue in results {

                    println!("{:#?}", issue);

                }

            }

            Err(err) => panic!("{:#?}", err),

        }

    }

}

```

## what's with the name

Jira's name is a [shortened form of gojira](https://en.wikipedia.org/wiki/Jira_(software)),

another name for godzilla. Goji is a play on that.

Doug Tangren (softprops) 2016-2018