https://github.com/xreedev/scp-api
This is a simple api to retreive data about various SCP entitities.
https://github.com/xreedev/scp-api
api flask json python requests scp
Last synced: 3 months ago
JSON representation
This is a simple api to retreive data about various SCP entitities.
- Host: GitHub
- URL: https://github.com/xreedev/scp-api
- Owner: xreedev
- Created: 2024-05-05T14:22:55.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T04:42:20.000Z (almost 2 years ago)
- Last Synced: 2025-01-30T09:42:31.344Z (over 1 year ago)
- Topics: api, flask, json, python, requests, scp
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```bash
git clone https://github.com/xreedev/SCP-API.git
```
2. Navigate to the project directory:
```bash
cd SCP-API
```
3. Install the required dependencies:
```bash
pip install Requirements.txt
```
## Usage
1. Run the Flask application:
```bash
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](LICENSE) file for details.