Skip to content

the-turing-index/api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues


Logo


Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

This is the Backend API for The Turing Index. It is a RESTful API that serves JSON.

Built With

  • Python 3.8.6
  • Flask 1.1.2
  • Continuous Integration with Travis CI
  • Continuous Deployment to Heroku

Getting Started

You can consume the API at `` or set it up locally for your development environment by following the instructions below.

Prerequisites

  • Get Python Version 3.8.6
    • TODO: Gist for pyenv instructions

Installation

  • Clone down this repo and cd into it
  • Activate a virtual environment
  • Install the dependencies
  • Start the server: python main.py
  • The API will run at localhost:5000

Usage

Request:

GET '/calendars'

Response:

{
  "data": {
    "id": null,
    "type": "calendars",
    "attributes": [
      {
        "mod1": {
          "frontend": {
            "zoom_link": ""
          },
          "backend": {
            "zoom_link": ""
          }
        }
      },
      {
        "mod2": {
          "frontend": {
            "zoom_link": ""
          },
          "backend": {
            "zoom_link": ""
          }
        }
      },
      {
        "mod3": {
          "frontend": {
            "zoom_link": ""
          },
          "backend": {
            "zoom_link": ""
          }
        }
      },
      {
        "mod4": {
          "zoom_link": ""
        }
      },
      {
        "community": {
          "zoom_link": ""
        }
      }
    ]
  }
}

Roadmap

See the open issues for a list of proposed features (and known issues).

Known Issues

The JSON response for /calendars currently does not serve live links to any meetings.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Project Link: https://github.com/your_username/repo_name

Acknowledgements

About

(DEPRECATED) This is the API for the Backend of the Turing Index

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages