AirBnB clone - MySQL
This directory contains all the tasks of the project "0x02. AirBnB clone - MySQL"
Table of Contents
Project General Objectives
- What is Unit testing and how to implement it in a large project.
- What is *args and how to use it.
- What is **kwargs and how to use it.
- How to handle named arguments in a function.
- How to create a MySQL database.
- How to create a MySQL user and grant it privileges.
- What ORM means.
- How to map a Python Class to a MySQL table.
- How to handle 2 different storage engines with the same codebase.
- How to use environment variables.
Project Description
The Airbnb clone is one of the main projects at Holberton School, it's a long term project that we need to accomplish by building up trough a series of small modules or pieces. This project is thinking as a whole for a software developer, to learn and become a full-stack developer, gluing alltogether the infrastructure of the Airbnb from back to front, including databases, static and dynamic content, web frameworks, APIs, and web infrastructure. The first step that we need to build is "the console" or the command interpreter, this is meant to be a tool to validate or manipulate the storage system, through the console we are gonna be able of:
- Create our data model.
- Manage (create, update, destroy, etc) objects.
- Store and persist objects to a file (JSON file)
This storage engine will give us an abstraction between “My object” and “How they are stored and persisted”.
You can find this in: AirBnB clone - The console
For the second part of the project we should build the database connection through SQLAlchemy, the ORM of Python.
Using a MySQL storage we replace the file storage (JSON file) by a Database storage and we map your models to a table in database by using an O.R.M.
Directory Files Description
| File | Description |
|---|---|
| Console | Program that contains the entry point of the command interpreter. |
| MySQL setup dev file | Script that prepares a MySQL server for the project. |
| MySQL setup test file | Script that prepares a MySQL server for the project. |
| Engine DBStorage | Module that serializes instances in a JSON file and deserializes JSON file to instances. |
| File Storage | Module that serializes instances in a JSON file and deserializes JSON file to instances. |
| BaseModel | Class BaseModel that defines all common attributes/methods for other classes. |
| City | File that contains the City class that inherit from BaseModel. |
| State | File that contains the State class that inherit from BaseModel. |
| User | File that contains the User class that inherit from BaseModel. |
| Place | File that contains the Place class that inherit from BaseModel. |
| Review | File that contains the Review class that inherit from BaseModel. |
| Amenity | File that contains the Amenity class that inherit from BaseModel. |
| init file | File that defines a Python Package. |
| AUTHORS | File that contains the AUTHORS of this project. |
| TESTS | Directory that contains all the Unittest files to test the different classes and methods. |
Prerequisites
This program was made and tested using Ubuntu 14.04.3 LTS and Python 3.4.3 So we recommend you to test this command interpreter under this conditions.
Built With
- Ubuntu 14.04.3 LTS Running on a Virtual Machine "Vagrant"
- GNU Emacs 24.3.1
- Python 3.4.3