0x00. AirBnB clone - The console

This project is the first step towards building a full web application: the AirBnB clone.

The console or command interpreter create the data model and allows create, update, destroy, store and persist objects to a file (JSON file). This console will be a tool to validate this storage engine.

Objectives
Requirements
Installation and execution
Console commands
Tests
Development environment
Authors

Objectives

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

Requirements

Airbnb was built and tested in Ubuntu 14.04 LTS via Vagrant in VirtualBox. Programming language python3

Installation and execution

Clone the repository

$ git clone https://github.com/ahmadoa/AirBnB_clone.git

Move into the directory

$ cd AirBnB_clone

Execute the console file

/AirBnB_clone$ ./console.py

How to Use Command Interpreter

The commands available for this command interpreter are:

Name	Sample usage	Description
`help`	`help`	Displays all commands available
`create`	`create <class>`	Creates new object (ex. a new User, Place)
`update`	`User.update('123', {'name' : 'Michael'})`	Updates attribute of an object
`destroy`	`User.destroy('123')`	Destroys specified object
`show`	`User.show('123')`	Retrieves an object from a file, a database
`all`	`User.all()`	Displays all objects in Class
`count`	`User.count()`	Returns count of objects in specified Class
`EOF`	`ctrl D`	Exits the console.
`quit`	`quit`	Exits the Console

create, destroy and update commands save changes into a JSON file.

Tests ⚙️

Interactive Mode

$ ./console.py
(hbnb) help

Documented commands (type help <topic>):
========================================
EOF  help  quit

(hbnb)
(hbnb)
(hbnb) quit
$

Non-Interactive Mode

$ echo "help" | ./console.py
(hbnb)

Documented commands (type help <topic>):
========================================
EOF  help  quit
(hbnb)
$
$ cat test_help
help
$
$ cat test_help | ./console.py
(hbnb)

Documented commands (type help <topic>):
========================================
EOF  help  quit
(hbnb)
$

Development Environment

Language: Python3
Operating System: Ubuntu 14.04 LTS
Style guidelines: PEP 8 (version 1.7) || Google Style Python Docstrings

Authors✒️

Ahmad Ouladaouid Software Engineering student at [ALX Africa](ALX Africa - Power Your Future in Tech)
Michael Kazembe - Software Engineering student at [ALX Africa](ALX Africa - Power Your Future in Tech)

saber0amine / AirBnB_clone