Giter VIP home page Giter VIP logo

movies's Introduction

Movies

Simple Django Rest Framework app providing REST API with movies downloaded from OMDB API.

Build Status Coverage Status

Getting Started

Movies is hosted on Heroku: http://moviesomdb.herokuapp.com

Running locally

Prerequisites

Install PostgreSQL 9.5+, Python 3.7 and Django 2.1

Create postgres account for Movies and write it's name in src/core/local_settings.py (see more) or export it in environment setting DATABASE_URL (see dj-database-url). Example:

DATABASE_URL=postgres://moviesuser:movies@localhost:5432/movies

Before installation and first usage you need to request for OMDB API-key and then store it in environment setting OMDB_API_KEY. If you don't want to store it in env you have to add it before all manage.py and gunicorn commands.

Installing

Run requirements installation and migrations:

pip install -r requirements.txt
cd src
python manage.py migrate

or if you don't have OMDB_API_KEY in env:

OMDB_API_KEY=abcdefg python manage.py migrate

Running the server

To run server locally use gunicorn:

gunicorn core.wsgi --log-file=- --pythonpath=src

Running the tests

Running django unit tests:

cd src && python manage.py test

API specification

See API.md file.

License

Almost whole project is provided on MIT License - see the LICENSE.md, feel free to use each part of the project you want, except API specification.

I'm not the author of API architecture and I can't grant any permission to reuse it.

movies's People

Contributors

kubked avatar

Watchers

James Cloos avatar  avatar

movies's Issues

Connect to landscape.io

It will be good to have code quality metrics. Create landscape.io config file and connect it to the repo.

Clear error responses

Some error responses contains garbage like some html with description. Remove these contents or even better replace them with JSON messages.

Style corrections

Fix few style issues:

  • sort imports,
  • make quotes and double quotes usage consistent,
  • write missing docstrings,
  • maybe merge api and core packages,

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.