ogd-api-files

WSGI APIs used by opengamedata-website

https://github.com/opengamedata/ogd-api-files

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization opengamedata has institutional domain (opengamedata.fielddaylab.wisc.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (5.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

WSGI APIs used by opengamedata-website

Basic Info
  • Host: GitHub
  • Owner: opengamedata
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 202 KB
Statistics
  • Stars: 0
  • Watchers: 3
  • Forks: 0
  • Open Issues: 8
  • Releases: 9
Created about 3 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

opengamedata-api-files

This is the backend api used by https://github.com/opengamedata/opengamedata-website

Getting Started:

Running the app locally via the development Flask server:

Steps to run:

  1. Ensure you have Python and pip installed in your development environment.
  2. From the app's root directory run pip install -r requirements.txt to ensure you have Flask and other dependencies installed for the app.
  3. If you don't have a config/config.py file for local development, copy config/config.py.template to config/config.py to create one. Populate config.py with secret values as needed.
  4. Run flask run or flask run --debug.
  5. A web server should be running at http://localhost:5000

API endpoints:

/getGameUsageByMonth Query string params: game_id, year, month

/getGameFileInfoByMonth Query string params: game_id, year, month

Owner

  • Name: Open Game Data
  • Login: opengamedata
  • Kind: organization

Open Game Data is a project out of the UW - Madison Field Day Lab to make datasets of anonymous play data public for science.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: opengamedata-website-api
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: Field Day Lab
    city: Madison
    country: US
    region: Wisconsin
    website: 'https://fielddaylab.wisc.edu/'
  - given-names: Luke
    family-names: Swanson
    email: lwswanson2@wisc.edu
    affiliation: Field Day Lab
    orcid: 'https://orcid.org/0000-0002-8455-7441'
  - given-names: David
    family-names: Gagnon
    email: djgagnon@wisc.edu
    affiliation: Field Day Lab
    orcid: 'https://orcid.org/0000-0001-5126-0476'
repository-code: 'https://github.com/opengamedata/opengamedata-website-api'
url: 'https://opengamedata.fielddaylab.wisc.edu/index.php'
license: MIT

GitHub Events

Total
  • Issues event: 12
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 20
  • Pull request event: 8
  • Create event: 5
Last Year
  • Issues event: 12
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 20
  • Pull request event: 8
  • Create event: 5