Giter Club home page Giter Club logo

star_wars_theclonewars_rest-api's Introduction

Star Wars: The Clone Wars REST API

REST API of Star Wars: The Clone Wars (animated series) chapter opening quotes.

TCW-API

Description

Star_Wars_TheCloneWars_REST-API is a REST API that provides opening quotes from the animated series Star Wars: The Clone Wars. It is built in Python using Flask and SQLite.

How to Run Locally

  1. Create virtual environment:

    • If you are using Windows, run create_env.bat.
    • If you are using bash, run create_env.sh.
    • The requirements will be installed automatically.\
  2. Start virtual environment:

    • If you are using Windows, use venv/Scripts/Activate in your terminal.
    • If you are using bash, use source/venv/bin/activate in your terminal.
    • With the virtual environment enabled, run main.py.

After completing these steps, the system will create the database and also insert the data, then it will start automatically.

URLs

  • GET /quotes: Returns the entire list of quotes.
  • GET /quotes/{language}: Returns quotes in the specified language.
    • Example: /quotes/english Returns all quotes in English.
  • GET /quotes/quote_id: Returns a quote by its ID.
    • Example: /quotes/1 Returns the appointment with ID 1.
  • GET /quotes/random/{language}: Returns a random quote in the specified language.
    • Example: /quotes/random/english Returns a random quote in English.
  • GET /languages: Returns the complete list of available languages.

Requirements

The requirements needed for this project are found in the file requirements.txt.

Main Files

  • main.py: Main file to run the application.
  • create_database.py: Script to create the database. (It runs automatically, do not touch)
  • create_env.bat & create_env.sh: Scripts to create the virtual environment.
  • requirements.txt: File with the necessary dependencies.

License

This project is licensed by Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0).


star_wars_theclonewars_rest-api's People

Contributors

astronautmarkus avatar marcoskingsduoc avatar

Stargazers

Soledad avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.