Installation

import PackageDescriptionletpackage=Package(  name:"MyAwesomeApp",    dependencies:[.package(url:"https://github.com/nerdishbynature/octokit.swift", from:"0.11.0"),])

Authentication

TokenConfiguration

letconfig=TokenConfiguration("YOUR_PRIVATE_GITHUB_TOKEN_HERE")

letconfig=TokenConfiguration("YOUR_PRIVATE_GITHUB_TOKEN_HERE", url:"https://github.example.com/api/v3/")

Octokit(config).me(){ responseinswitch response{case.success(let user):print(user.loginasAny)case.failure(let error):print(error)}}

OAuthConfiguration

letconfig=OAuthConfiguration(token:"<Your Client ID>", secret:"<Your Client secret>", scopes:["repo","read:org"])leturl= config.authenticate()

letconfig=OAuthConfiguration("https://github.example.com/api/v3/", webURL:"https://github.example.com/", token:"<Your Client ID>", secret:"<Your Client secret>", scopes:["repo","read:org"])

// AppDelegate.swiftconfig.authenticate()func application(application:UIApplication, openURL url:NSURL, sourceApplication:String?, annotation:AnyObject?)->Bool{  config.handleOpenURL(url){ configinself.loadCurrentUser(config) // purely optional of course}returnfalse}func loadCurrentUser(config:TokenConfiguration){Octokit(config).me(){ responseinswitch response{case.success(let user):print(user.login)case.failure(let error):print(error)}}}

lettoken= // get your token from your keychain, user defaults (not recommended) etc.let config=TokenConfiguration(token)Octokit(config).user(name:"octocat"){ responseinswitch response{case.success(let user):print("User login:\(user.login!)")case.failure(let error):print("Error:\(error)")}}

Users

Get a single user

letusername=... // set the usernameOctokit().user(name: username){ responseinswitch response{case.success(let user):      // do something with the user    case.failure(let error):      // handle any errors}}

Get the authenticated user

Octokit().me(){ response inswitch response{case.success(let user):      // do something with the user    case.failure(let error):      // handle any errors}

Repositories

Get a single repository

let(owner, name)=("owner","name") // replace with actual owner and nameOctokit().repository(owner, name){ responseinswitch response{case.success(let repository):      // do something with the repository    case.failure(let error):      // handle any errors}}

Get repositories of authenticated user

Octokit().repositories(){ responseinswitch response{case.success(let repository):      // do something    case.failure(let error):      // handle any errors}}

Starred Repositories

Get starred repositories of some user

letusername="username"Octokit().stars(username){ responseinswitch response{case.success(let repositories):      // do something with the repositories    case.failure(let error):      // handle any errors}}

Get starred repositories of authenticated user

Octokit().myStars(){ responseinswitch response{case.success(let repositories):      // do something with the repositories    case.failure(let error):      // handle any errors}}

Follower and Following

Get followers of some user

letusername="username"Octokit().followers(username){ responseinswitch response{case.success(let users):      // do something with the users    case.failure(let error):      // handle any errors}}

Get followers of authenticated user

Octokit().myFollowers(){ responseinswitch response{case.success(let users):      // do something with the users    case.failure(let error):      // handle any errors}}

Get following of some user

letusername="username"Octokit().following(username){ responseinswitch response{case.success(let users):      // do something with the users    case.failure(let error):      // handle any errors}}

Get following of authenticated user

Octokit().myFollowing(){ responseinswitch response{case.success(let users):      // do something with the users    case.failure(let error):      // handle any errors}}

Issues

Get issues of authenticated user

Octokit(config).myIssues(){ responseinswitch response{case.success(let issues):        // do something with the issues    case.failure:        // handle any errors}}

Get a single issue

let(owner, repo, number)=("owner","repo",1347) // replace with actual owner, repo name, and issue numberOctokit(config).issue(owner, repository: repo, number: number){ responseinswitch response{case.success(let issue):        // do something with the issue    case.failure:        // handle any errors}}

Open a new issue

Octokit(config).postIssue("owner", repository:"repo", title:"Found a bug", body:"I'm having a problem with this.", assignee:"octocat", labels:["bug","duplicate"]){ responseinswitch response{case.success(let issue):        // do something with the issue    case.failure:        // handle any errors}}

Edit an existing issue

Octokit(config).patchIssue("owner", repository:"repo", number:1347, title:"Found a bug", body:"I'm having a problem with this.", assignee:"octocat", state:.Closed){ responseinswitch response{case.success(let issue):        // do something with the issue    case.failure:        // handle any errors}}

Comment an issue

Octokit().commentIssue(owner:"octocat", repository:"Hello-World", number:1, body:"Testing a comment"){ responseinswitch response{case.success(let comment):        // do something with the comment    case.failure:        // handle any errors}}

Edit an existing comment

Octokit().patchIssueComment(owner:"octocat", repository:"Hello-World", number:1, body:"Testing a comment"){ responseinswitch response{case.success(let comment):        // do something with the comment    case.failure:        // handle any errors}}

Pull requests

Get a single pull request

Octokit().pullRequest(owner:"octocat", repository:"Hello-World", number:1){ responseinswitch response{case.success(let pullRequests):            // do something with a pull request        case.failure:            // handle any errors}}

List pull requests

Octokit().pullRequests(owner:"octocat", repository:"Hello-World", base:"develop", state:Openness.Open){ responseinswitch response{case.success(let pullRequests):        // do something with a pull request list        case.failure:        // handle any errors}}

Update an exisiting Pull Request

Octokit().patchPullRequest(session, owner:"octocat", repository:"Hello-World", number:1, title:"Updated title", body:"The updated body", state:.open, base:"base-branch", mantainerCanModify:true){ responseinswitch response{case.success(let pullrequest):        // do something with the pullrequest        case.failure:        // handle any errors}}

Releases

Create a new release

Octokit().postRelease(owner:"octocat", repository:"Hello-World", tagName:"v1.0.0", targetCommitish:"master", name:"v1.0.0 Release", body:"The changelog of this release", prerelease:false, draft:false){ responseinswitch response{case.success(let release):        // do something with the release        case.failure:        // handle any errors}}