Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/harshanarayana/cookiecutter-sanic

A starter Kit to create skeleton for your Sanic Application with Support for Docker and Docker Compose
https://github.com/harshanarayana/cookiecutter-sanic

Last synced: 2 months ago
JSON representation

A starter Kit to create skeleton for your Sanic Application with Support for Docker and Docker Compose

Host: GitHub
URL: https://github.com/harshanarayana/cookiecutter-sanic
Owner: harshanarayana
License: mit
Created: 2018-11-09T19:38:54.000Z (about 6 years ago)
Default Branch: develop
Last Pushed: 2019-10-08T16:24:56.000Z (over 5 years ago)
Last Synced: 2024-08-03T22:15:41.331Z (6 months ago)
Language: Python
Size: 90.8 KB
Stars: 47
Watchers: 5
Forks: 6
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-sanic - Cookiecutter-Sanic

README

        # Cookiecutter Sanic Package

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fharshanarayana%2Fcookiecutter-sanic.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fharshanarayana%2Fcookiecutter-sanic?ref=badge_shield)

[![Build Status](https://semaphoreci.com/api/v1/harshanarayana/cookiecutter-sanic/branches/master/badge.svg)](https://semaphoreci.com/harshanarayana/cookiecutter-sanic)

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

[Cookiecutter](https://github.com/audreyr/cookiecutter) template for Sanic Applications

# Feature

 

* Swagger support via [sanic-openapi](https://github.com/huge-success/sanic-openapi)

* `Docker` and `docker-compose` Support

* `Gunicorn` App runner setup

* Conditional requirements.txt management

* JSON logging for `Docker` containers

* Wrapper for `sanic` App Configuration via environment variable prefix

* Default `health` and `status` API blueprints

* `tox` Environment Setup with `py35`, `py36` `py37`

* Unit testing via `pytest` and `pytest-sanic`

* CI support for `travis`

* Github Issue and PR templates

* Mupltiple Runner options

    * Gunicorn

    * Sanic Dev mode with Auto Reload

    * With Sanic Workers and no Dev mode

    * With Async Support

* Documentation via `sphinx`

* Automated Release version management using `bumpversion`

* Automated change log management using `gitchangelog`

* Python based Build Support and Make file based build support

* Editor Config support

# Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.6.0 or higher):

```bash

pip install -U cookiecutter

```

Generate a Python package project:

```bash

cookiecutter https://github.com/harshanarayana/cookiecutter-sanic.git

```

# To Do

- [ ] Authentication Support (JWT, Basic Auth)

- [x] Rate Limiter

- [ ] Caching Support via Redis/memcached

- [x] ORM/Database Integration

- [x] Automated Release Management

- [x] Automated Change Log Generator

# Credits

This template enables automated release version management and changelog generated via the following projects. 

## Versioning

[`bumpversion` by `peritus`](https://github.com/peritus/bumpversion)

## Change Log Management

[`gitchangelog` by `vaab`](https://github.com/vaab/gitchangelog) 

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fharshanarayana%2Fcookiecutter-sanic.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fharshanarayana%2Fcookiecutter-sanic?ref=badge_large)