0x00. AirBnB clone - The console 0x00.Table of contents

0x01 Introduction
0x02 Environment
0x03 Installation
0x04 Testing
0x05 Usage
0x06 Authors

0x01 Introduction

Team project to build a clone of AirBnB.

The console is a command interpreter to manage objects abstraction between objects and how they are stored.

To see the fundamental background of the project visit the Wiki.

The console will perform the following tasks:

create a new object
retrive an object from a file
do operations on objects
destroy an object

Storage

All the classes are handled by the Storage engine in the FileStorage Class. 0x02 Environment

Suite CRM terminal python Suite CRM Suite CRM git distributed version control system Github

Style guidelines:
    pycodestyle (version 2.7.*)
    PEP8

All the development and testing was runned over an operating system Ubuntu 20.04 LTS using programming language Python 3.8.3. The editors used were VIM 8.1.2269, VSCode 1.6.1 and Atom 1.58.0 . Control version using Git 2.25.1. 0x03 Installation

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

change to the AirBnb directory and run the command:

./console.py

Execution

In interactive mode

$ ./console.py (hbnb) help

Documented commands (type help ):

EOF help quit

(hbnb) (hbnb) (hbnb) quit $

in Non-interactive mode

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

Documented commands (type help ):

EOF help quit (hbnb) $ $ cat test_help help $ $ cat test_help | ./console.py (hbnb)

Documented commands (type help ):

EOF help quit (hbnb) $

0x04 Testing

All the test are defined in the tests folder. Documentation

Modules:

python3 -c 'print(import("my_module").doc)'

Classes:

python3 -c 'print(import("my_module").MyClass.doc)'

Functions (inside and outside a class):

python3 -c 'print(import("my_module").my_function.doc)'

and

python3 -c 'print(import("my_module").MyClass.my_function.doc)'

Python Unit Tests

unittest module
File extension .py
Files and folders star with test_
Organization:for models/base.py, unit tests in: tests/test_models/test_base.py
Execution command: python3 -m unittest discover tests
or: python3 -m unittest tests/test_models/test_base.py

run test in interactive mode

echo "python3 -m unittest discover tests" | bash

run test in non-interactive mode

To run the tests in non-interactive mode, and discover all the test, you can use the command:

python3 -m unittest discover tests

0x05 Usage

Start the console in interactive mode:

$ ./console.py (hbnb)

Use help to see the available commands:

(hbnb) help

Documented commands (type help ):

EOF all count create destroy help quit show update

(hbnb)

Quit the console:

(hbnb) quit $

Commands

The commands are displayed in the following format Command / usage / example with output

Create

Creates a new instance of a given class. The class' ID is printed and the instance is saved to the file file.json.

create

(hbnb) create BaseModel 6cfb47c4-a434-4da7-ac03-2122624c3762 (hbnb)

Show

show

(hbnb) show BaseModel 6cfb47c4-a434-4da7-ac03-2122624c3762 [BaseModel] (a) [BaseModel] (6cfb47c4-a434-4da7-ac03-2122624c3762) {'id': '6cfb47c4-a434-4da7-ac03-2122624c3762', 'created_at': datetime.datetime(2021, 11, 14, 3, 28, 45, 571360), 'updated_at': datetime.datetime(2021, 11, 14, 3, 28, 45, 571389)} (hbnb)

Destroy

Deletes an instance of a given class with a given ID. Update the file.json

(hbnb) create User 0c98d2b8-7ffa-42b7-8009-d9d54b69a472 (hbnb) destroy User 0c98d2b8-7ffa-42b7-8009-d9d54b69a472 (hbnb) show User 0c98d2b8-7ffa-42b7-8009-d9d54b69a472 ** no instance found ** (hbnb)

all

Prints all string representation of all instances of a given class. If no class is passed, all classes are printed.

(hbnb) create BaseModel e45ddda9-eb80-4858-99a9-226d4f08a629 (hbnb) all BaseModel ["[BaseModel] (4c8f7ebc-257f-4ed1-b26b-e7aace459897) [BaseModel] (4c8f7ebc-257f-4ed1-b26b-e7aace459897) {'id': '4c8f7ebc-257f-4ed1-b26b-e7aace459897', 'created_at': datetime.datetime(2021, 11, 13, 22, 19, 19, 447155), 'updated_at': datetime.datetime(2021, 11, 13, 22, 19, 19, 447257), 'name': 'My First Model', 'my_number': 89}"] ["[BaseMode

count

Prints the number of instances of a given class.

(hbnb) create City 4e01c33e-2564-42c2-b61c-17e512898bad (hbnb) create City e952b772-80a5-41e9-b728-6bc4dc5c21b4 (hbnb) count City 2 (hbnb)

update

Updates an instance based on the class name, id, and kwargs passed. Update the file.json

(hbnb) create User 1afa163d-486e-467a-8d38-3040afeaa1a1 (hbnb) update User 1afa163d-486e-467a-8d38-3040afeaa1a1 email "aysuarex@gmail.com" (hbnb) show User 1afa163d-486e-467a-8d38-3040afeaa1a1 [User] (s) [User] (1afa163d-486e-467a-8d38-3040afeaa1a1) {'id': '1afa163d-486e-467a-8d38-3040afeaa1a1', 'created_at': datetime.datetime(2021, 11, 14, 23, 42, 10, 502157), 'updated_at': datetime.datetime(2021, 11, 14, 23, 42, 10, 502186), 'email': 'aysuarex@gmail.com'} (hbnb)

Authors Sani Abuh Ibrahim Blessing Onghaji Ukatu