Skip to content

Latest commit

 

History

History
218 lines (162 loc) · 6.6 KB

README.md

File metadata and controls

218 lines (162 loc) · 6.6 KB
Raw

Flaskipy

Flaskipy CLI will help you to create a RESTFul backend including PostgreSQL.

Table of Contents

Background

Will be added

Python Version

Minimum python version should have 3.x.x or upper

Install

A step by step series of examples that tell you have to get a development env running

asciicast

How do I get set up?

If you would like to used Virtualenv Install the virtualenv using this command(If you have not installed virtualenv yet.)

$ [sudo] pip install virtualenv

Learn more to visit Virtualenv, User Guide

$[sudo] pip install flaskipy

OR, git clone

$ git clone https://github.com/osmangoninahid/flaskipy

$ cd flaskipy
$ pip install -r requirements.txt
$ python setup.py install

Usage

When you will initializing, here you will be asked a question and you have to answer

Example:

[?] What's your project name ?: YOUR_PROJECT_NAME

// Initialize project
$ cd [project_name]

// Project structue initialize
$ flaskipy init

// Add new module
$ flaskipy module --name YourModuleName

// OR
$ flaskipy module

How to Run this project

// Development
$ cd [project_name]
$ python main.py

It should make a question, like

  • Name of the project (It will create a folder in your current working directory and the folder name will be your project name)

Display the command options with the -h option:

$ flaskipy -help

Usage: flaskipy [OPTIONS] COMMAND [ARGS]...

Options:
--help  Show this message and exit.

Commands:
init    Project structure initializer :return: None
module  Automatically create module :param name: str...

Project Structure

├── config.ini
├── config.py
├── main.py
├── modules
│   ├── blogs
│   │   ├── controllers
│   │   │   ├── blogs.py
│   │   │   ├── __init__.py
│   │   ├── __init__.py
│   │   ├── models
│   │   │   ├── blog.py
│   │   │   ├── __init__.py
│   │   └── routes
│   │       ├── __init__.py
│   ├── posts
│   │   ├── controllers
│   │   │   ├── posts.py
│   │   │   ├── __init__.py
│   │   ├── __init__.py
│   │   ├── models
│   │   │   └── __init__.py
│   │   │   └── post.py
│   │   └── routes
│   │       ├── __init__.py
│   ├── __init__.py
├── README.md
├── tests
│   └── __init__.py
└── utils
    └── __init__.py

Endpoints

Request Response
GET base-url/posts This will return all example with pagination support
POST base-url/posts This will create a new example
GET base-url/posts/{id} This will return a example
PUT base-url/posts/{id} This is for updating a example
DELETE base-url/posts This will delete the example with identification

Features Released

  • RestAPI Boilerplate
  • Flaskipy CLI

Upcoming Features

  • JWT integration for authentication and authorization
  • DeployNow integration
  • ApiDoc generation
  • Automated deploy with guinicorn and Python-Fabric
  • Dockerize
  • and Based on feedback

Maintainers

Contributes

See the list of contributors who participated in this project.

How to become a contributor

If you want to contribute to Flaskipy and make it better, your help is very welcome. You can make constructive, helpful bug reports, feature requests and the noblest of all contributions. If like to contribute in a good way, then follow the following guidelines.

How to make a clean pull request

  • Create a personal fork on Github.
  • Clone the fork on your local machine.(Your remote repo on Github is called origin.)
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on! Branch from dev.
  • Implement/fix your feature, comment your code.
  • Follow Flaskipy's code style, including indentation(4 spaces).
  • Write or adapt tests as needed.
  • Add or change the documentation as needed.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request to the dev branch.
  • Once the pull request is approved and merged, please pull the changes from upstream to your local repo and delete your extra branch(es).

License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.