ladalo-daniel / airbnb_clone

Alx group/team project for AirBnB_clone

AirBnB_clone - The Console

AirBnB Clone - The Console

For further information, click on the above link

Airbnb Clone - Structure

UML - Airbnb Console

Contents:

• Project Description
• General Objetives
• Command Interpreter Description
  • How to start it
  • Commands and their usage
  • How to use it
  • examples
• Unittests

Project Description

Airbnb Clone is the main project of the second trimester at Holberton School. The aim is to develop an entire web application that simulates the behavior of the Airbnb platform. Starting from the console or command interpreter, to manipulate data without a visual interface, like in a Shell (perfect for development and debugging), followed by the construction of a website (the front-end) that shows the final product to everybody: static and dynamic, once it's finished what follows is the connection with the database or files that store data (data = objects). And last but not least, the creation of an API that provides a communication interface between the front-end and your data (retrieve, create, delete, update them).

General Objetives

• How to create a Python package
• How to create a command interpreter in Python using the cmd module
• What is Unit testing and how to implement it in a large project
• How to serialize and deserialize a Class
• How to write and read a JSON file
• How to manage datetime
• What is an UUID
• What is *args and how to use it
• What is **kwargs and how to use it
• How to handle named arguments in a function

Command Interpreter Description

• How to start it

  • Follow the instructions to get a copy of the program and run in your local machine:

    Clone the following repository. https://github.com/HibeeK/AirBnB_clone.git

    Run the program ./console.py

• Commands and their usage

Command	Usage	Example	Description
create	create <class name>	create BaseModel	Creates a new instance of BaseModel, saves it (to the JSON file) and prints the id.
show	show <class name>	show BaseModel 1234-1234-1234	Prints the string representation of an instance based on the class name and id.
destroy	destroy <class name>	destroy BaseModel 1234-1234-1234	Deletes an instance based on the class name and id (save the change into the JSON file).
all	all <class name> or all	all BaseModel	Prints all string representation of all instances based or not on the class name.
update	update <class name> <id> <attribute name> "<attribute value>"	update BaseModel 1234-1234-1234 email "[email protected]"	Updates an instance based on the class name and id by adding or updating attribute (save the change into the JSON file).
all()	<class name>.all()	User.all()	Retrieve all instances of a class
count()	<class name>.count()	User.count()	Retrieve the number of instances of a class
show()	<class name>.show(<id>)	User.show("246c227a-d5c1-403d-9bc7-6a47bb9f0f68")	etrieve an instance based on its ID
destroy()	<class name>.destroy(<id>)	User.destroy("246c227a-d5c1-403d-9bc7-6a47bb9f0f68")	Destroy an instance based on his ID
update()	<class name>.update(<id>, <attribute name>, <attribute value>)	User.update("38f22813-2753-4d42-b37c-57a17f1e4f88", "age", 89)	Update an instance based on his ID
update() with dictionary	<class name>.update(<id>, <dictionary representation>)	User.update("38f22813-2753-4d42-b37c-57a17f1e4f88", {'first_name': "John", "age": 89})	Update an instance based on his ID with a dictionary

Prerequisites

For further installation is necessary to set this program on Ubuntu 14.04 LTS using Vagrant in VirtualBox.

You need to install this software

1. VirtualBox - Virtual Machine
2. Vagrant
3. Emacs
4. Vim/Vi
5. VSCode
6. Usage: ./console.py

Authors

• Mbonu Onyinye Rose
• Ladalo Daniel