Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/m4cs/jsonsty

:cloud: Free Cloud JSON Storage Written in Python :snake:
https://github.com/m4cs/jsonsty

cloud-storage cloud-storage-solution flask json-api json-data json-storage json-storage-service mongodb python

Last synced: about 2 months ago
JSON representation

:cloud: Free Cloud JSON Storage Written in Python :snake:

Awesome Lists containing this project

README 

        


    

    


    Made with Python and Flask

    


    

    

    

    

    




# JSONsty



What is JSONsty? JSONsty is a service provided by [psty.io](https://psty.io) that allows you to store JSON data in the cloud for free using an extremely simple API or web panel frontend. The source code here includes everything running on the [website](https://json.psty.io) as we speak. It should always be 1:1 up-to-date on the `master` branch compared to the website.



# How Does It Work?



JSONsty is a Flask application that includes a REST API and dynamically rendered Website using the Jinja2 module. It interfaces and stores all data on a remote mongoDB cluster that acts as the master database. Users have an account which links the data, known as `stores`, on the database, and then link said store to the user.



When you create an account you receive an API Key which allows you to communicate with our API. The API allows you to create, edit, grab, and delete stored JSON data on our servers. The website is a graphical version of the API which offers all functionality the API does, and more. The more comes from the ability to live edit and replace stores of data. It also allows you to change certain account settings, like regenerating API keys, that the API does not alone.



# Getting Started



To get started as a user, signup on the [website here](https://json.psty.io) and login to your account. When you login to your account and go to `Account Settings` you will see your API Key:






This will be your token for Authenticating with the JSONsty API. More info on the API can be found [here on the documentation page](https://json.psty.io).



# JSONsty's Development





    




JSONsty was written in Python using the Flask framework. The development enviroment is pretty simple to setup. Poetry is used for dependency management and for a virtual env. You can install `poetry` by running `pip install poetry`. You will have to be on the first stable release or higher though as that's what this was built with. 



To run the development environment first make sure you setup a `.config.json` file with your credentials for a test database. An example `.config.json` looks like this:



```json

{

    "MONGO_URI": "",

    "TEST_MONGO_URI": "",

    "SECRET_KEY": "",

    "RECAPTCHA_ENABLED": false,

    "RECAPTCHA_SITE_KEY": "",

    "RECAPTCHA_SECRET_KEY": ""

}

```



**Make sure to set RECAPTCHA_ENABLED to False or you will run into issues with reCaptcha verification.** You will also need to be hosting your own mongoDB node. You can register [here](https://mongodb.com) and get a free 520MB cluster to test with or use in your own projects. You can also run mongoDB locally but you'll need to generate the connection URI correctly.



To run the development server run the following commands:



```

# On *nix

chmod +x prepare-testing.sh

./prepare-testing.sh



# On Windows

prepare-testing.bat

```



This will setup the test_app correctly for you and will also use the `TEST_MONGO_URI` value from your `.config.json`.



# Contributing



Any and all PRs are welcomed and appreciated. When contributing make sure to keep in mind that we are using `poetry` to version control this project. Please make sure to update your `poetry.lock` file when adding new dependencies and make note in any PRs of those types of additons. 



# License



Licensed under MIT 2019 Max Bridgland