ogd-api-utils
Package of utilities for server-side scripts in OpenGameData.
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 (11.0%) to scientific vocabulary
Repository
Package of utilities for server-side scripts in OpenGameData.
Basic Info
Statistics
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
- Releases: 17
Metadata Files
README.md
opengamedata-api-utils
Repository for utility server-side script and classes used by OpenGameData APIs.
Contents
Python Package
The utils repository contains a package that can be installed from pip, and places its classes under the ogd.apis namespace.
The available modules include:
HelloAPI.py: Class for creating a "Hello, World" API to aid in testing deploys of other APIs.schemas: Contains a base class for server config schemas to handle version and debug-level config itemsutils: Contains helper classes for API requests and responses, as well as general-purpose parsing and setup functions.
Data Store Utilities
The store directory contains a script for reindexing a folder of OGD datasets after new datasets have been added.
This index is used by the FileAPI to check what datasets are available on the server.
Getting Started
Hello World of Flask
Steps to run:
- Check out latest
opengamedata-server. - Run
pip install -r requirements.txtto ensure you've got flask. - Run
flask run. - Open localhost:5000 or localhost:5000/hello to see some really basic text output from the Flask server.
If Flask doesn't run, it's possible you'd need to first export FLASKAPP as an environment variable, set to "wsgi" (so in Bash, export FLASKAPP=wsgi). However, the script is named wsgi.py specifically because Flask is supposed to auto-detect it. So if this issue ever did come up, please ping Luke so he can look into it.
Owner
- Name: Open Game Data
- Login: opengamedata
- Kind: organization
- Website: opengamedata.fielddaylab.wisc.edu
- Repositories: 11
- Profile: https://github.com/opengamedata
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-server
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-server'
license: MIT
GitHub Events
Total
- Create event: 2
- Release event: 1
- Issues event: 5
- Delete event: 1
- Push event: 3
- Pull request event: 2
Last Year
- Create event: 2
- Release event: 1
- Issues event: 5
- Delete event: 1
- Push event: 3
- Pull request event: 2
Dependencies
- flask ==2.0.1
- flask-restful ==0.3.9
- google-auth ==1.34.0
- python-dateutil ==2.8.1
- typing ==3.7.4.3
- ./.github/actions/apis_config * composite
- actions/checkout v3 composite
- actions/upload-artifact v2 composite
- burnett01/rsync-deployments 5.2 composite
- ./.github/actions/apis_config * composite
- actions/checkout v3 composite
- actions/upload-artifact v2 composite
- burnett01/rsync-deployments 5.2 composite