jizhang27 / QuickFlix-crawler

0 stars 0 forks source link

Purpose

Web crawler to crawler web content relating movie comments.

Development Environment Setup

===

  1. install Python 2
  2. $ cd ProjectFolder
  3. Follow this link to create an isolated python virtual evnviroment. note the folder should be venv.
    • On OS X and Linux: $ . venv/bin/activate.
    • ON Windows: $ v-env\scripts\activate.
  4. Before proceed to next step, make sure you will see (ENV) in your shell
  5. $ pip install -r requirements.txt to install all required packages.

Database Setup

===

  1. Download MongoDB community server
  2. Follow this guide to setup & run mongoDb locally

Dependency

===

Coding Convention

===

JUST BE CONSISTENT!

Comments
  1. inline & block comment: start with # Number Sign.
  2. docstrings: surround by ''' ''' or """ """.
Naming
  1. function_name and variable_Name: lowercase, with words separated by underscores.
  2. CONSTANT_NAME: all capital letters with words underscores separated by underscores.