github-lister-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be1e198375f2783e65381f8668c7bd4abc56d2e3cdc6a78b2929f19b4ccd9f4f
+  data.tar.gz: 68a794988bbe92f704d94d350c7c21b2aff0a1c3a90aa9d530efe03cf49628b6
+SHA512:
+  metadata.gz: bb99c15f2c71b763e67bb84414f9d4ca1b8d206c00d39f283ea4c3a36a2ced6253cb40f8de57b52a27588ebeb382ebd40617478d7de27b22e584f831c4fadcb7
+  data.tar.gz: 9b46b2fbfec39bc13880995eb1b8c432dd1d6df2b93a8756e8814f87c9b4fd6eb79246987ed475babbe47917ce12edb512aab78830fd14b83ec406c60e2fd9a9

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+#
+# These owners will be the default owners for everything in the repo.
+#
+*	@TGWolf
+

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at . All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/.github/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+Please refer to the [contributing](https://github.com/WolfSoftware/contributing) documentation.
+
+## Important
+
+ALL commits must be signed to ensure the identity of the developer, any pull requests that are made with unsigned commits will be rejected as a matter of course.
+
+> This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting with this repository, organization, or community you agree to abide by its terms.

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# Funding
+# https://help.github.com/en/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository
+
+ko_fi: wolfsoftware

data/.github/ISSUE_TEMPLATE/ask_question.md

@@ -0,0 +1,10 @@
+---
+name: Ask a question
+about: Feel free to ask us a question
+title: ''
+labels: 'question'
+assignees: 'TGWolf'
+
+---
+
+**What would you like to know?**

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: 'TGWolf'
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1.
+2.
+3.
+4.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment**
+Any relevant information about your environment, OS version, virtualised or not.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: 'TGWolf'
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
+
+**Summary**
+
+<!-- Summary of the PR -->
+
+This PR fixes/implements the following **bugs/features**
+
+* [ ] Bug 1
+* [ ] Feature 1
+* [ ] Breaking changes
+
+<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
+
+Explain the **motivation** for making this change. What existing problem does the pull request solve?
+
+<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
+
+**Test plan (required)**
+
+Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots help greatly.
+
+<!-- Make sure tests pass on both Travis. -->
+
+**Closing issues**
+
+<!-- Put `fixes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
+Fixes #

data/.github/SECURITY.md

@@ -0,0 +1,39 @@
+# Security Policies and Procedures
+
+This document outlines security procedures and general policies for this project.
+
+  * [Reporting a Bug](#reporting-a-bug)
+  * [Disclosure Policy](#disclosure-policy)
+  * [Comments on this Policy](#comments-on-this-policy)
+
+## Reporting a Bug
+
+We take **ALL** security related bugs and issues very seriously.
+
+If you think you have identified a security related issue, please [report it immediately](mailto:disclose@wolfsoftware.com) 
+and include the word "SECURITY" in the subject line. If you are not sure, don’t worry.
+Better safe than sorry – just send an email.
+
+* Please provide as much information as you can.
+* Please do not open issues related to any security concerns publicly.
+* Please do not include anyone else on the disclosure email.
+
+Report security bugs in third-party modules to the person or team maintaining
+the module.
+
+## Disclosure Policy
+
+When a security report is received, we will carry out the following steps:
+
+  * Confirm the problem and determine the affected versions.
+  * Audit code to find any potential similar problems.
+  * Prepare fixes for all releases still under maintenance. These fixes will be
+    released as fast as possible.
+
+We will endeavor to keep you informed of the progress towards a fix 
+and full announcement, and may ask for additional information or guidance.
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved please submit a
+pull request.

data/.github/SUPPORT.md

@@ -0,0 +1,8 @@
+# Support
+
+If the documentation is not providing the information that you require then you have a couple of options:
+
+1. [Start a discussion](https://github.com/DevelopersToolbox/github-lister-core/discussions).
+1. [Open an issue](https://github.com/DevelopersToolbox/github-lister-core/issues), using the `Ask a question` option.
+
+> This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting with this repository, organization, or community you agree to abide by its terms.

data/.gitignore

@@ -0,0 +1,17 @@
+**/ab-results*
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/Gemfile.lock
+
+*.gem

data/.reek.yml

@@ -0,0 +1,10 @@
+---
+detectors:
+    TooManyStatements:
+        max_statements: 10
+    TooManyMethods:
+        max_methods: 20
+    DataClump:
+        enabled: false
+    NilCheck:
+        enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+    NewCops: enable
+    TargetRubyVersion: 2.5
+
+Layout/IndentationWidth:
+    Width: 4
+
+Layout/LineLength:
+    Enabled: false
+
+Naming/FileName:
+    Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+    PreferredName: exception
+
+Style/FrozenStringLiteralComment:
+    Enabled: false
+
+Style/HashSyntax:
+    EnforcedStyle: hash_rockets
+
+Style/RaiseArgs:
+    EnforcedStyle: compact
+
+Style/Semicolon:
+    AllowAsExpressionSeparator: true
+
+Style/SymbolArray:
+    Enabled: false
+

data/.travis.yml

@@ -0,0 +1,129 @@
+matrix:
+  include:
+  - language: ruby
+    name: Bundler (rvm 2.5)
+    rvm: 2.5
+    before_install:
+    - gem install bundler
+  - language: ruby
+    name: Bundler (rvm 2.6)
+    rvm: 2.6
+    before_install:
+    - gem install bundler
+  - language: ruby
+    name: Bundler (rvm 2.7)
+    rvm: 2.7
+    before_install:
+    - gem install bundler
+  - language: ruby
+    name: Bundler (rvm 3.0)
+    rvm: 3.0
+    before_install:
+    - gem install bundler
+  - language: ruby
+    name: Rubocop (rvm 2.5)
+    rvm: 2.5
+    before_install:
+    - git clone https://github.com/TravisToolbox/rubocop.git
+    install:
+    - "./rubocop/install.sh"
+    script:
+    - "./rubocop/scan.sh"
+  - language: ruby
+    name: Rubocop (rvm 2.6)
+    rvm: 2.6
+    before_install:
+    - git clone https://github.com/TravisToolbox/rubocop.git
+    install:
+    - "./rubocop/install.sh"
+    script:
+    - "./rubocop/scan.sh"
+  - language: ruby
+    name: Rubocop (rvm 2.7)
+    rvm: 2.7
+    before_install:
+    - git clone https://github.com/TravisToolbox/rubocop.git
+    install:
+    - "./rubocop/install.sh"
+    script:
+    - "./rubocop/scan.sh"
+  - language: ruby
+    name: Rubocop (rvm 3.0)
+    rvm: 3.0
+    before_install:
+    - git clone https://github.com/TravisToolbox/rubocop.git
+    install:
+    - "./rubocop/install.sh"
+    script:
+    - "./rubocop/scan.sh"
+  - language: ruby
+    name: Reek (rvm 2.5)
+    rvm: 2.5
+    before_install:
+    - git clone https://github.com/TravisToolbox/reek.git
+    install:
+    - "./reek/install.sh"
+    script:
+    - "./reek/scan.sh"
+  - language: ruby
+    name: Reek (rvm 2.6)
+    rvm: 2.6
+    before_install:
+    - git clone https://github.com/TravisToolbox/reek.git
+    install:
+    - "./reek/install.sh"
+    script:
+    - "./reek/scan.sh"
+  - language: ruby
+    name: Reek (rvm 2.7)
+    rvm: 2.7
+    before_install:
+    - git clone https://github.com/TravisToolbox/reek.git
+    install:
+    - "./reek/install.sh"
+    script:
+    - "./reek/scan.sh"
+  - language: ruby
+    name: Reek (rvm 3.0)
+    rvm: 3.0
+    before_install:
+    - git clone https://github.com/TravisToolbox/reek.git
+    install:
+    - "./reek/install.sh"
+    script:
+    - "./reek/scan.sh"
+  - language: ruby
+    name: YAML Linting (rvm 2.7)
+    rvm: 2.7
+    before_install:
+    - git clone https://github.com/TravisToolbox/yaml-lint
+    install:
+    - "./yaml-lint/install.sh"
+    script:
+    - "./yaml-lint/scan.sh"
+  - language: bash
+    name: Shellcheck (Bash)
+    os: linux
+    arch: arm64-graviton2
+    before_install:
+    - git clone https://github.com/TravisToolbox/shellcheck
+    install:
+    - "./shellcheck/install.sh"
+    script:
+    - "./shellcheck/scan.sh"
+  - language: ruby
+    name: Link Checking (rvm 2.7)
+    rvm: 2.7
+    env:
+    - WHITELIST="https://img.shields.io"
+    - EXCLUDE_FILES="CHANGELOG.md,github-lister-core.gemspec"
+    before_install:
+    - git clone https://github.com/TravisToolbox/awesomebot
+    install:
+    - "./awesomebot/install.sh"
+    script:
+    - "./awesomebot/scan.sh"
+notifications:
+  email: false
+  slack:
+    secure: OAh1PldyUAdO1CaXQhktRIqxWJc0O7D+3aHr1b6iiK4l2Kkzy2UcRYevw61UoBZj3/7PAnC1Pp0PttekcqAtrTx6ZVA9SP2md0BT9M0VzDrSePxT4T0gnj+ESb6vT4xYS0jz83hu4T+s0YoRrCZR4OOWyFHobEJzxxjRjf4nK9ldmwMaSFlncGst9tHIxjKgKApnnA0TttreVDM4y6Szq1CAUv0N6MUN+bIzwaQhKAhjdRqmZEYsufxeia6WUeN57z6Bt06y5pCSt5rwF3uQUxN8zcP7Sl5nCqBhlsh+LlXYUOlK7l8tVJ4r/yX0reHf8YXqA+IEKVatpjSNu4c9M6zyku/L547hWyRuVKe/Q4ADWgI45pipweE79dRCwPmclNNT8obhoQcaLGWj1wsV9udibOy8fGZYWXESTk6pUCcQWJmdIoyvrCgICvRFCs6QfzWqKcgerkv+8V1RwlPx7wAStRvgOAmoZ3RLjjbXbwymriHYTIim1grDTegQZJa4R3ITUuzy8R0Neod/HO5FO1M/XMiFJI2qIpjX1hT5gFRSb2JvzK0JrdAiuZ8xEk02r8Ix/hxJCF95TSe9VmIL5wKKp108OwXXOisF/bNzExgRK5gGKnNMoFW2aVmM3SAd9R8JPWdVwRTrS7PEdQE6NDKZsXaqITLy6KpPMGxcSrY=

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+
+This changelog was automatically generated using [Caretaker](https://github.com/DevelopersToolbox/caretaker) by [Wolf Software](https://github.com/WolfSoftware)
+
+### [Unreleased](https://github.com/DevelopersToolbox/github-lister-core/compare/v0.1.0...HEAD)
+
+- Spell checking [`[head]`](https://github.com/DevelopersToolbox/github-lister-core/commit/)
+
+- Final pre-release flight check [`[2788d33]`](https://github.com/DevelopersToolbox/github-lister-core/commit/2788d33540ad219e8ce1bcaad6d60f84d560e118)
+
+- Pre-release [`[bdc0937]`](https://github.com/DevelopersToolbox/github-lister-core/commit/bdc09379f4ecdc14a36698384400860308762854)
+
+- Pre-release [`[5f23931]`](https://github.com/DevelopersToolbox/github-lister-core/commit/5f2393147b2b149472cc0f9ca5a1b6407eef621d)
+
+- Cleaning [`[dfdc9c9]`](https://github.com/DevelopersToolbox/github-lister-core/commit/dfdc9c9f689e3973eb417793807e5e69184dcaed)
+
+- Lots of changes [`[4906d56]`](https://github.com/DevelopersToolbox/github-lister-core/commit/4906d565a2df9dbee91ab1055acbdb4bd5b3d194)
+
+- Create publib / private functions [`[d0c9b7d]`](https://github.com/DevelopersToolbox/github-lister-core/commit/d0c9b7df4a5d25ade1dc53cb1c6832381421e55e)
+
+- fix [`[99e9078]`](https://github.com/DevelopersToolbox/github-lister-core/commit/99e9078d97bab679ad8f2b0267ea7c72fbc0f423)
+
+- Added some basic docs for developers, added WAY more tests [`[e388381]`](https://github.com/DevelopersToolbox/github-lister-core/commit/e3883819591e5918f6a1db834072bb364f14256b)
+
+- First major push [`[af06a65]`](https://github.com/DevelopersToolbox/github-lister-core/commit/af06a658bb68ba204a790fa6758b4929090545ee)
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in slackit.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2009-2021` `Wolf Software Limited`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+<h1 align="center">
+	<a href="https://github.com/WolfSoftware">
+		<img src="https://raw.githubusercontent.com/WolfSoftware/branding/master/images/general/banners/64/black-and-white.png" alt="Wolf Software Logo" />
+	</a>
+	<br>
+	Github Lister Core Library
+</h1>
+
+<p align="center">
+	<a href="https://travis-ci.com/DevelopersToolbox/github-lister-core">
+		<img src="https://img.shields.io/travis/com/DevelopersToolbox/github-lister-core/master?style=for-the-badge&logo=travis" alt="Build Status">
+	</a>
+	<a href="https://github.com/DevelopersToolbox/github-lister-core/releases/latest">
+		<img src="https://img.shields.io/github/v/release/DevelopersToolbox/github-lister-core?color=blue&style=for-the-badge&logo=github&logoColor=white&label=Latest%20Release" alt="Release">
+	</a>
+	<a href="https://github.com/DevelopersToolbox/github-lister-core/releases/latest">
+		<img src="https://img.shields.io/github/commits-since/DevelopersToolbox/github-lister-core/latest.svg?color=blue&style=for-the-badge&logo=github&logoColor=white" alt="Commits since release">
+	</a>
+	<a href="LICENSE.md">
+		<img src="https://img.shields.io/badge/license-MIT-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" alt="Software License">
+	</a>
+	<br>
+	<a href=".github/CODE_OF_CONDUCT.md">
+		<img src="https://img.shields.io/badge/Code%20of%20Conduct-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+	<a href=".github/CONTRIBUTING.md">
+		<img src="https://img.shields.io/badge/Contributing-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+	<a href=".github/SECURITY.md">
+		<img src="https://img.shields.io/badge/Report%20Security%20Concern-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+	<a href=".github/SUPPORT.md">
+		<img src="https://img.shields.io/badge/Get%20Support-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+</p>
+
+## Overview
+
+The gem aims to provide a simple, fast and, clean way to extract repository information from GitHub. It comes with several methods but it is intentionally limited to repository based information. 
+
+If you are looking for a GitHub API wrapper we suggest looking at the [Octokit](https://rubygems.org/gems/octokit) gem, which is the tool we have used in this project.
+
+This was written to work as the lookup core for some other projects, but we felt people may be able to make use of it as a standalone library.
+
+To make the lookups as fast as possible we make extensive use of the [Parallel](https://rubygems.org/gems/parallel) gem to run as many API queries as possible in parallel.
+
+## Usage
+
+```ruby
+require 'github-lister-core'
+
+# Not a real token
+options = { :token => '1234567890abcdef1234567890abcdef1234567890abcdef' }
+
+GithubListerCore.user_repos(options)
+```
+
+> You can access all of the methods using the alias GCL instead of GithubListerCore
+
+### Methods
+
+| Function | Purpose |
+| -------- | ------- |
+| user\_repos | Details about all of the repositories owned by the user |
+| org\_repos | Details about all repositories within an organisation |
+| org\_members_repos | Details about all repositories in all organisations a user is a member of |
+| all\_repos | user\_repos + user\_org\_repos |
+| org\_membership | Details about all the organisation a user is a member of | 
+
+#### Method Returns
+
+All of the exposed methods will return data in JSON format.
+
+### Options
+
+| Option Name | Purpose |
+| ----------- | ------- |
+| :token | The GitHub authentication token (require if no username) |
+| :user or :username | The GitHub username to use when performing queries (If no username is given, the username of the current authenticates user will be used instead) |
+| :org or :org_name | The name of the organisation to use when performing queries. (This is only used by the org_repos method and is required for this method) |
+| :use_slugs | This will return only the repo name (:full_name) or the organisation name (:login) instead of the full details |
+| :add_topics | This will add the repository topics to the details (Requires an additional look query per repo) |
+| :add_latest_release | This will add information about the latest release to the details (Requires an additional look query per repo) |
+| :add_releases | This will add information about releases to the repository (Requires an additional look query per repo) |
+| :add_languages | This will add the repository languages to the details (Requires an additional look query per repo) |
+
+> :user, :username, :org, :org_name can be either a single user/organisation name _OR_ a comma-separated list of user/organisation names _OR_ an array of user/organisation names. If more than one name is given, the results for all names will be merged together into one result set.
+
+## Contributing
+
+We are always happy for people to contribute, if you want to do so the following information should assist you in setting up a local dev environment.
+
+Please keep in mind the purpose of this tool, it implements a very specific and narrow set of the GitHub API but this is by design, so we may not always accept pull requests if we feel they are taking the project too far beyond its designed scope.
+
+### Setup
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Testing
+
+For local testing make sure that you run `bundle exec rspec spec` and then `rake install` to install the gem locally.
+
+For further information please refer to the [contributing](.github/CONTRIBUTING.md) documentation.
+
+## Contributors
+
+<p>
+	<a href="https://github.com/TGWolf">
+		<img src="https://img.shields.io/badge/Wolf-black?style=for-the-badge" />
+	</a>
+</p>
+
+## Show Support
+
+<p>
+	<a href="https://ko-fi.com/wolfsoftware">
+		<img src="https://img.shields.io/badge/Ko%20Fi-blue?style=for-the-badge&logo=ko-fi&logoColor=white" />
+	</a>
+</p>

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION.txt

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'github/lister/core'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)