https://github.com/luckykadam/kickup

Kickup: Template for Quick Projects (Machine Coding Interviews)
https://github.com/luckykadam/kickup

csv-parser interview python quick-start-project system-design template

Last synced: 15 days ago
JSON representation

Kickup: Template for Quick Projects (Machine Coding Interviews)

• Host: GitHub
• URL: https://github.com/luckykadam/kickup
• Owner: luckykadam
• License: mit
• Created: 2019-11-16T07:06:46.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-10T14:14:35.000Z (about 5 years ago)
• Last Synced: 2024-11-28T18:27:31.282Z (2 months ago)
• Topics: csv-parser, interview, python, quick-start-project, system-design, template
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kickup

Kickup: Template for Quick Projects (Machine Coding Interviews)

## About

This repo serves as a great starting point for fast prototype projects.

* Specially useful in Machine Coding interviews, when time is limited (~1 hour) and you can't afford to waste time on boiler plate code.

* Implementation of Data Access Layer (csv) and Command Line Interface is provided, which are essential components of a demoable project.

* Compelte code is under 200 line of code, which makes it easy to understand and extend.

## Design

The code is designed as three modules.

1. Command line interface: The module responsible for interaction with the end-user. It can be replaced with any kind of interface without affecting other module. For example: it can be replaced by REST API.

2. Business Logic: This module contains the core logic of the application.

3. Data Access Object: This module is responsible for interacting with the storage and provide the data to the application. Currently it reads from csv file, and keeps the data in memory. It can easily be replaced with another DAO which interacts with Database.

## Implementation

Implementation is done in python3.6. No external library is used.


 Although it implements Group Management System, this code can be used as a started code for any quick project.

### Files

All the source code is inside `src` directory.

* **command_line_interface.py**

This file represents Command Line Interface module. It interacts directly with `GroupManager`, but not with data access module.


 It extends [Cmd](https://docs.python.org/3/library/cmd.html#cmd.Cmd) class, and can be started by `cmdloop` function.

* **group_manager.py**

This file represents Group Management module. It interacts directly with data access module.

It provides functions: `check_user_in_group`, `add_user_to_group` and `remove_user_from_group`.

* **csv_dao.py**

This file represents CSV Data Access Object module. It interacts with storage(csv files) to provide data access to other modules.

* **models.py**

This file contains the definition of entities.

* **main.py**

This file stitch together all the module into an application.

* **exceptions.py**

This file contains definition of commonly occurring exceptions.

## Usage/Execution

The application can be started using command

```

cd src

python src/main.py

```

The program load the data from data directory and provides a command prompt for basic functionality.

### Commands

1. `help`: To know about available commands.

2. `users`: To see all users.

3. `groups`: To see all groups.

4. `assign  `: To assign a user to a group.

5. `remove  `: To remove a user from a group.

6. `exit`: To exit from command prompt.