Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 1.54 KB

RUNNING_GUIDE.md

File metadata and controls

63 lines (45 loc) · 1.54 KB

RUNNING GUIDE

Quick Start

To quickly get started with the application, clone the repository and run the application using the provided commands.

System Requirements

  • Operating System: Windows/Linux/Mac
  • Python: Version 3.7 or higher
  • Required Libraries: List out libraries needed.

Installation Steps

  1. Clone the repository: 
    git clone https://github.com/rahulmisra2010-ctrl/PDF-Manager.git
cd PDF-Manager
  2. Install dependencies: 
    pip install -r requirements.txt

Running Instructions

To run the application, execute the following command:

python app.py

Testing All 8 Methods

The application includes 8 methods for extracting data. To test them, follow these steps:

  1. Navigate to the appropriate directory.
  2. Run tests for each method, using commands like: 
    python -m unittest test_method1.py
    Repeat for all methods.

Expected Results

Upon successful execution, you should see respective outputs for each method as defined in the documentation of the application.

API Endpoints

  • GET /api/method1: Description
  • POST /api/method2: Description
  • Include all relevant API endpoints here

Troubleshooting

  • If you encounter issues, check for the following:
    • Ensure all system requirements are met.
    • Verify installation instructions were followed correctly.

Verification Checklist

  • System Requirements fulfilled
  • Installation successful
  • Application runs without errors
  • All extraction methods provide expected results