https://github.com/chris104957/crudcast

Create and deploy a RESTful API with a few lines of YAML
https://github.com/chris104957/crudcast

crud crud-generator flask mongodb rest-api

Last synced: about 2 months ago
JSON representation

Create and deploy a RESTful API with a few lines of YAML

• Host: GitHub
• URL: https://github.com/chris104957/crudcast
• Owner: chris104957
• Created: 2018-12-04T06:10:56.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-18T16:38:39.000Z (about 6 years ago)
• Last Synced: 2024-08-08T23:22:42.247Z (5 months ago)
• Topics: crud, crud-generator, flask, mongodb, rest-api
• Language: Python
• Homepage: http://crudcast.rtfd.io/
• Size: 131 KB
• Stars: 33
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Crudcast

[![Coverage Status](https://coveralls.io/repos/github/chris104957/crudcast/badge.svg?branch=02-unit-tests)](https://coveralls.io/github/chris104957/crudcast?branch=02-unit-tests)

[![Build Status](https://travis-ci.org/chris104957/crudcast.svg?branch=master)](https://travis-ci.org/chris104957/crudcast)

[![Documentation Status](https://readthedocs.org/projects/crudcast/badge/?version=latest)](https://crudcast.readthedocs.io/en/latest/?badge=latest)

Crudcast lets you build a fully functioning and OpenAPI-compliant CRUD API with basic auth/user management with a few lines of YAML code.

## Installation

Crudcast requires mongodb - install and start as follows:

```

brew install mongodb

brew service start mongodb

```

Install crudcast

```

pip install crudcast

```

Create a config file, `config.yml`, in the same folder

```

models:

  person:

    fields:

      first_name:

        required: true

      last_name:

        required: true

      age:

        type: number

```

Usage

---

CD into the folder containing your `config.yml`, and run this command

```

crudcast

```

Go to `http://localhost:5000/api/docs` to see your documented and fully-functional API

Next steps

----------

Crudcast also allows you to protect your routes with authentication,

and even create additional API routes by inserting your own Python code

Please go to http://crudcast.rtfd.io/ for the full docs

Roadmap

---

Crudcast is brand new and only has a small percentage of the intended functionality so far. In future, I am planning to add support for:

- More authentication methods (OAuth, Token auth, etc)

- Advanced permissions

- Custom validation/permissions

If there is any other functionality you'd like to see added, then please raise an issue