Giter Club home page Giter Club logo

deepopinion_backend_challenge's Introduction

deepopinion_backend_challenge

This project is a DeepOpinion Challenge: Sr.

Basic Commands

Build Stack

docker-compose -f local.yml build

Run the Stack

docker-compose -f local.yml up

Execute Management Commands

docker-compose -f local.yml run --rm django python manage.py migrate docker-compose -f local.yml run --rm django python manage.py createsuperuser

How to Use this Project

  1. Run the build command
  2. Run the stack command to start the project
  3. To upload CSV file, make post request to this endpoint: http://0.0.0.0:8000/api/v1/datas/upload-csv/
  4. To upload Excel file, make post request to this endpoint: http://0.0.0.0:8000/api/v1/datas/upload-excel/
  5. To get all data, make a get request to this endpoint: http://0.0.0.0:8000/api/v1/datas/data/
  6. To get single data, make a get request to this endpoint: http://0.0.0.0:8000/api/v1/datas/data/{id}
  7. To add and chaange tags to data, make a put request to this endpoint: http://0.0.0.0:8000/api/v1/datas/data/{id}
  8. To get all available sentiment, make a get rquest to the endpoint: http://0.0.0.0:8000/api/v1/datas/data/get_sentiment/
  9. To get all available aspect, make a get rquest to the endpoint: http://0.0.0.0:8000/api/v1/datas/data/get_aspects/
  10. Make sure the CSV and Excel file header name is Text, for data to be uploaded

What to Do

  1. I was supposed to include download feature for CSV and Excel file
  2. I was supposed to add asynchronous task to all the request in the project but because of time i couldn't do that
  3. I was supposed to write test cases for the programme but because of time I couldn't do it.
  4. I was supposed to cache end point that retrieve data from the database but due to time I couldn't do it.

Type checks

Running type checks with mypy:

$ mypy deepopinion_backend_challenge

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.

Docker

See detailed cookiecutter-django Docker documentation.

deepopinion_backend_challenge's People

Contributors

kcalifdimy 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.