AMITY ALLOCATOR
Intro
Amity Allocator is a CLI based Python app that enables creation of rooms, addition of people into the system and their reallocation to various rooms as need arises.
System requirements
- Python version 3.5 +
- Python virtialenv
- SQLite3
Setup
git@github.com:andela-ekaranja/Amity.git
for SSH orhttps://github.com/andela-ekaranja/Amity.git
for HTTPS.- Create a virtualenv and activate it.
- In your shell,
cd
into the app root and runpip install -r requirements.txt
- To start the app run
python -i app.py
Usage
create_room <room_type> <room_name>
: Creates a new roomadd_person <first_name> <last_name> <designation> [<needs_accomodation>]
: Adds a new person and allocates them a random room.print_room <room_name>
: Prints all the members of the specified room.reallocate_person <name> <new_room>
: Moves a person from one room to another.load_people <filename>
: Does batch addition of people using data from afilename.txt
print_allocations [<filename>]
: Prints all rooms and the people in them and optionally writes the data tofilename.txt
.print_unallocated [<filename>]
: Prints all the people that haven't been allocated and optionally writes the data tofilename.txt
.load_state [<filename>]
: Loads data from the specified SQLite db into the appsave_state [<db_name>]
: Persists data stored in the app to a SQLite DB(-i | --interactive)
-h --help Show this screen.
: Shows help text-i --interactive Interactive mode.
Starts the app in interactive mode
Tests
To run tests, run nosetests
or nosetests --with-coverage
Contributing
The app is free and open for anyone that feels they have features they can add or change. Just fork and start contributing.
Released under the MIT lisence.