Skip to content

This is a simple api to retreive data about various SCP entitities.

Notifications You must be signed in to change notification settings

xreedev/SCP-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SCP API

This is a simple Flask API that serves data from a text file (test.txt) as JSON.This was built as a simple project to better understand APIs

Installation

  1. Clone the repository:

    git clone https://github.com/xreedev/SCP-API.git
  2. Navigate to the project directory:

    cd SCP-API
  3. Install the required dependencies:

    pip install Flask

Usage

  1. Run the Flask application:

    python app.py
  2. Access the API in your web browser or using a tool like cURL:

    http://localhost:7775/
    

File Structure

  • app.py: Contains the Flask application code.
  • test.txt: Input data file.
  • test3.json: Output JSON file.
  • README.md: Project documentation.

The apicall.py file can be sued to test run the api after updating the ipaddress value with your host address

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

This is a simple api to retreive data about various SCP entitities.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages