/django-rest-sqlite-template

Cookiecutter template for demo Django RESTful API tests

Primary LanguagePythonMIT LicenseMIT

Django RESTful API Project Template (SQLite)

Template for stand-alone Django REST Framework demo projects.

Getting Started

This is a cookiecutter template to read more about cookiecutter templates please refer to the docs here.

CookieCutter Installation

It's recommended that you use pyenv, which you can read about more here.

There is a pyenv-installer if you want to use that.

curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash

Install a version of python, below is an example of how to do this.

pyenv install -s 3.8.6

Upgrade pip and install cookiecutter globally,

pip install --upgrade pip && pip install cookiecutter

Usage

To use this template you can run the following command:

cookiecutter gh:anthonyalmarza/drf-lambda-project

Template Options

  • repo_name - The name of the base folder for the github repo. e.g. "some_demo"
  • project_name - The package name for the django project, defaults to repo_name.
  • project_title - The display name for the project e.g. "Some Demo"
  • project_description - The short description for the project e.g. "A test drf project"
  • author_name - The author's name.
  • author_email - The author's email address.
  • github_username - The github username or organization where this project will live.