Airbnb Clone Console

Contents

• Description
• Directories and Files
• Commands
• Installation
• Requirements
• Example Commands
• Build with
• Authors

---

Description

In the next few months, we at Holberton School will be creating the AirBnB clone project, and how it says is a clone of the AirBnB application. We will face and develop this project in parts like:

• The console
• Web static
• MySQL storage
• Web framework - templating
• RESTful API
• Web dynamic

In this repository we face the first part: The console, this is the first step towards building our first full web application: the AirBnB clone. In this part we created a command interpreter to manipulate data without a visual interface and we create and manage our first Store Engine.

---

Directories and Files

---

Directories

---

Directory	Description
models	This package contains the modules and classes to create an specific object
engine	This package contains the module to manage the file storage
tests	This package contains all the test for models and classes
scripts	This directory contains the script to generate the AUTHORS file

---

Files	Description
console.py	The console file
AUTHORS	This file contains all the authors of this project

models directory

---

File	Description
amenity.py	The amenity subclass
base_model.py	The base model superclass
city.py	The city subclass
place.py	The place subclass
review.py	The review subclass
state.py	The state subclass
user.py	The user subclass

engine directory

---

File	Description
file_storage.py	The file storage class

tests directory

---

File	Description
test_amenity.py	Unittest module for amenity
test_base_model.py	Unittest module for base model
test_city.py	Unittest module for city
test_place.py	Unittest module for place
test_review.py	Unittest module for review
test_state.py	Unittest module for state
test_user.py	Unittest module for user
test_engine/test_file_storage.py	Unittest module for file storage

---

Commands

---

Basic commands to use the console

---

Command	Usage	Example	Functionality
help	help	help	Display the list of the commands that can be executed
create	create <class>	create Place	Creates a new instance of a class
show	show <class> <id>	show Place 123-123-123	Shows a specific instance
destroy	destroy <class> <id>	destroy Place 123-123-123	deletes a specific instance
all	all or all <class>	all Place	Shows all instances or shows an entire class
update	update <class> <id> <attribute> <value>	update User 123-123-123 email 'hello@hello.com'	Updates an specific attribute of an instance
quit	quit	quit	Quits the console
EOF	Ctr+D	EOF	Quits the console with keyboard interruption

Installation

git clone https://github.com/espinosakev24/AirBnB_clone.git

---

Requirements

The console was built and tested in Ubuntu 14.04 LTS, interpreted/compiled using python3 (version 3.4.3)

_All the tests should be executed by using this command:_ `python3 -m unittest discover tests`

_Also you can test file by file by using this command:_ `python3 -m unittest tests/test_models/test_base_model.py`

---

Example Commands

Interactive Mode

Display the command help and do two empty lines

---

$ ./console.py
(hbnb) help

Documented commands (type help <topic>):
========================================
EOF  all  count  create  destroy  help  quit  show  update
(hbnb)
(hbnb)
(hbnb)
(hbnb) quit
$

Using the commands

---

$ ./console.py
(hbnb) create BaseModel
5dccfbf9-03a6-45f7-8a75-80094392bf97
(hbnb) show BaseModel 5dccfbf9-03a6-45f7-8a75-80094392bf97
[BaseModel] (5dccfbf9-03a6-45f7-8a75-80094392bf97) {'id': '5dccfbf9-03a6-45f7-8a75-80094392bf97', 'updated_at': datetime.datetime(2018, 6, 13, 23, 10, 13, 549740), 'created_at': datetime.datetime(2018, 6, 13, 23, 10, 13, 549699)}
(hbnb) all
[[BaseModel] (5dccfbf9-03a6-45f7-8a75-80094392bf97) {'id': '5dccfbf9-03a6-45f7-8a75-80094392bf97', 'updated_at': datetime.datetime(2018, 6, 13, 23, 10, 13, 549740), 'created_at': datetime.datetime(2018, 6, 13, 23, 10, 13, 549699)}]
(hbnb) BaseModel.count
1
(hbnb) update BaseModel 5dccfbf9-03a6-45f7-8a75-80094392bf97 number 89
(hbnb) show BaseModel 5dccfbf9-03a6-45f7-8a75-80094392bf97
[BaseModel] (5dccfbf9-03a6-45f7-8a75-80094392bf97) {'number': '89', 'updated_at': datetime.datetime(2018, 6, 13, 23, 11, 51, 470426), 'created_at': datetime.datetime(2018, 6, 13, 23, 10, 13, 549699), 'id': '5dccfbf9-03a6-45f7-8a75-80094392bf97'}
(hbnb) create User
71e19890-6440-4ca9-9976-59ba61571f09
(hbnb) all
[[User] (71e19890-6440-4ca9-9976-59ba61571f09) {'id': '71e19890-6440-4ca9-9976-59ba61571f09', 'updated_at': datetime.datetime(2018, 6, 13, 23, 12, 39, 71568), 'created_at': datetime.datetime(2018, 6, 13, 23, 12, 39, 71532)}, [BaseModel] (5dccfbf9-03a6-45f7-8a75-80094392bf97) {'number': '89', 'updated_at': datetime.datetime(2018, 6, 13, 23, 11, 51, 470426), 'created_at': datetime.datetime(2018, 6, 13, 23, 10, 13, 549699), 'id': '5dccfbf9-03a6-45f7-8a75-80094392bf97'}]
(hbnb) destroy User 71e19890-6440-4ca9-9976-59ba61571f09
(hbnb) all
[[BaseModel] (5dccfbf9-03a6-45f7-8a75-80094392bf97) {'number': '89', 'updated_at': datetime.datetime(2018, 6, 13, 23, 11, 51, 470426), 'created_at': datetime.datetime(2018, 6, 13, 23, 10, 13, 549699), 'id': '5dccfbf9-03a6-45f7-8a75-80094392bf97'}]
(hbnb) destroy BaseModel 5dccfbf9-03a6-45f7-8a75-80094392bf97
(hbnb) all
[]
(hbnb) quit
$

Non-Interactive Mode

Display the command help

---

$ echo "help" | ./console.py
(hbnb)
Documented commands (type help <topic>):
========================================
EOF  all  count  create  destroy  help  quit  show  update

(hbnb) $
$

Using the commands

---

$ echo "create BaseModel" | ./console.py
(hbnb) f09bfbad-532d-4bbe-a2c1-815b1958f01e
(hbnb) $
$ echo "all" | ./console.py
(hbnb) [[BaseModel] (f09bfbad-532d-4bbe-a2c1-815b1958f01e) {'id': 'f09bfbad-532d-4bbe-a2c1-815b1958f01e', 'updated_at': datetime.datetime(2018, 6, 13, 23, 16, 30, 420332), 'created_at': datetime.datetime(2018, 6, 13, 23, 16, 30, 420300)}]
(hbnb) $
$ echo "destroy BaseModel f09bfbad-532d-4bbe-a2c1-815b1958f01e" | ./console.py
(hbnb) (hbnb) $
$ echo "all" | ./console.py
(hbnb) []
(hbnb) $
$

---

Build with

• Python3: Language builded
• Ubuntu 14.04 LTS: Operative System
• PEP8: Style guide for Python code in ver. 1.7

---

Authors

Daniela Chamorro - Twitter -

Kevin Espinosa - Twitter -