Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/escapedshadows/api-hostify
API Hostify, a free open-source project by EscapedShadows, transforms any Python-supported device into a JSON API with three versions: Bucket, Bin, and Container. Each version offers unique features for organizing data. It optimizes performance and ease of use.
https://github.com/escapedshadows/api-hostify
api-rest flask flask-api hosting python self-hosted
Last synced: 6 days ago
JSON representation
API Hostify, a free open-source project by EscapedShadows, transforms any Python-supported device into a JSON API with three versions: Bucket, Bin, and Container. Each version offers unique features for organizing data. It optimizes performance and ease of use.
- Host: GitHub
- URL: https://github.com/escapedshadows/api-hostify
- Owner: EscapedShadows
- License: apache-2.0
- Created: 2024-05-27T18:59:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-15T16:59:40.000Z (5 months ago)
- Last Synced: 2025-01-11T13:17:57.256Z (14 days ago)
- Topics: api-rest, flask, flask-api, hosting, python, self-hosted
- Language: Python
- Homepage: https://apihostify.escapedshadows.com
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SOME FILES ARE NOT AVAILABLE YET. PLEASE BE PATIENT.
# API Hostify
A project by EscapedShadows for **everyone** and completely **Free**.
---
API Hostify is an open-source project maintained by EscapedShadows, licensed under the Apache 2.0 License.
API Hostify enables anyone to quickly transform any Python-supporting device into a simple JSON API.
There are three versions of API Hostify:
- Bucket
- Bin
- Container
Each version has its own advantages and disadvantages.
Let's explore the versions and understand their differences!
## Bucket
As you might have guessed, Bucket utilizes a common method for storing mass JSON data (slightly modified): with something called "Buckets."
You can imagine it as having a folder with many files named Bucket01.json, Bucket02.json, etc.
It's easy to keep this system organized, but it can be challenging to remember where specific data is stored.
## Bin
Essentially, Bin is a larger version of Bucket that utilizes the original system of Bucket data storage.
Instead of just having files, each bucket is another folder, allowing you to create as many files in one bucket as you want.
This can lead to some confusion and difficulty in finding data (we are working on a system to export all data in the near future).
## Container
Container is not a larger version of Bin but rather a mass storage consisting of **one** single JSON file storing **all** of the data.
This system is typically used for smaller projects.
## Why did I create this project?
I created this project because I understand the difficulties of writing a simple and clean API, ensuring it works, fixing bugs, handling system implementations, writing documentation, and maintaining the project. Plus, I enjoy providing free resources.
---
# Future Plans
In the future, I plan to:
- Add a system to export all data of a bucket or the entire API at once.
- Implement configurable backups.
- Improve planning and development based on user feedback.
---
# Setup
This section is Temporary!
To install a version use
```bash
curl -o hostifySetup.py https://raw.githubusercontent.com/EscapedShadows/Api-Hostify/main/{version}.py
```
For Example
```bash
curl -o containerSetup.py https://raw.githubusercontent.com/EscapedShadows/Api-Hostify/main/container.py
```
Please be patient, as the setup instructions will be provided soon.