Barissa-Imran / AirBnB_clone

Alx Airbnb project

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](https://www.airbnb.com/). The console is a command interpreter to manage objects abstraction between objects and how they are stored. The console will perform the following tasks:

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

0x02-environment

• 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/ferddymalemo08/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 <topic>):
========================================
EOF  help  quit

(hbnb)
(hbnb)
(hbnb) quit
$

in 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)
$

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

0x06-authors

Imran Barissa [e-mail]

Patrick Ndolo [e-mail]