I would like to develop a rest interface for the UGC’s league data. UGC is a free league, staffed by volunteers and has limited resources for development projects. With a restful interface, third-party developers would be able to use UGC data to develop tools and services that would assist the UGC community. Various community members have created small tools already, but developing these tools is difficult as data must be retrieved by parsing UGC web pages. These web pages are not guaranteed to remain the same, and they contain superfluous formatting and rendering data.
Requirements:
- Rest interfaces for
- Players
- Teams
- Matches
- Schedules
- JSON
- Open Sourced
- Simple Operation
- Clear documentation
- Clear HTTP error code usage
What:
- Python Flask application
- UWSGI/Gunicorn application manager
- Nginx proxy
Potential Issues
- Application Hosting
- Who pays?
- Database load
- At what percentage capacity is the database currently
- Rate limiting (is it necessary?)
- Database access
- Remote access and security
- Operations, code maintenance
- Who is doing it?
Plan:
- Get schema and which database software is used (MySQL, Postgres, etc)
- Plan interface layout and seek feedback
- Build out a single rest interface with tests
- Demo test version of above, get feedback
- Repeat for each rest interface
- Acquire hosting
- Deploy and announce production version
TronPaul for prez! 👍