README.md

Directory Hunt

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact

About The Project

A GET REST API that takes in a path given by the user. We run the "ls -la" OS command on the path and translate the output into JSON format. This application is Dockerized with unit tests.

Built With

• Docker
• Python
• FastAPI
• Pytest

Getting Started

Prerequisites

• Docker

  brew cask install docker

Installation

1. Run in terminal of your choice:

   ./getpath.sh

NOTE: Some paths you may need give Docker permission to access!

2. Open in browser of your choice this link:

   http://0.0.0.0:80
   

Testing

• Run Pytest

  pytest

Docs

See swagger.yaml file in the repository for Swagger style documentation

Contact

Rebecca Hsieh - [email protected] - therealslimhsiehdy.com