https://github.com/hackoregon/2019-backend-cookiecutter-django

Cookiecutter template for creating a backend image
https://github.com/hackoregon/2019-backend-cookiecutter-django

Last synced: about 1 year ago
JSON representation

Cookiecutter template for creating a backend image

• Host: GitHub
• URL: https://github.com/hackoregon/2019-backend-cookiecutter-django
• Owner: hackoregon
• License: mit
• Created: 2019-05-01T02:40:27.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-09T23:55:05.000Z (about 4 years ago)
• Last Synced: 2025-03-28T03:15:02.153Z (about 1 year ago)
• Language: Python
• Size: 914 KB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# backend-cookiecutter-django

[![Build Status](https://travis-ci.org/hackoregon/2019-backend-cookiecutter-django.svg?branch=master)](https://travis-ci.org/hackoregon/2019-backend-cookiecutter-django)

A cookiecutter template for creating reusable Django REST Framework

packages with the best practices quickly. This template is customized to

provide structure for quickstarting a Hack Oregon civic data project.

# What is Hack Oregon?

[Hack Oregon](http://www.hackoregon.org/) is a rapid prototyping lab taking a creative approach to

data projects that bring insight to complex issues in the public

interest. We’re a community-powered nonprofit, our teams are made of

volunteers, and all the work we do is open source.

# Features

  - Pytest testing

  - Sane setup.py for easy PyPI registration/distribution

  - MIT Open Source Licensed

  - Standard templates for README, issues and pull requests,

    Contribution guidelines

# Requirements

This repo uses the [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) templating project. You will need to

install Cookiecutter. The recommended method is by a pip install:

``` bash

$ pip install cookiecutter

```

# Usage

A more in-depth Training and User Guide is available [here](docs/training/TrainingGuide,pdf)

To generate a new repo:

    $ cookiecutter gh:hackoregon/2019-backend-cookiecutter-django --checkout BRANCH

You can leave out the `--checkout BRANCH` if checking out from MASTER.

You'll be prompted for some questions, answer them, then it will create

a backend-cookiecutter-django with your new package.

At this point, you are ready to connect with an external git and start coding.

## API Standards

Hack Oregon API developers should refer to our [Current API Standards Guide](docs/standards/v1/STANDARDS.md) for guidance on developing APIs for Hack Oregon.

## Cookiecutter values

You will be asked the following information when creating a project:

    {

      "full_name": "Your full name here",

      "email": "you@example.com",

      "github_username": "yourname",

      "hack_oregon_team": "Transportation Systems",

      "year": "2019",

      "project_root_path":"transportation",

      "github_repo": "2019-transportation-systems-backend",

      "python_package_namespace": "hackoregon_transportation_systems",

      "python_subpackage": "toad",

      "project_short_description": "Your project description goes in here",

      "version": "0.1.0",

      "gis_project": "True"

    }

## Explanation

  - full_name: Your name as project originator (for credit in

    documentation)

  - email: Your email address

  - github_username: Your github username

  - hack_oregon_team: Canonical name for the Hack Oregon Project Team,

  - year: Year project is worked on

  - project_root_path - the url path project will be served on (after host name)

    ie Transportation Systems or Sandbox

  - github_repo: naming of repo within the hackoregon organization, ie:

    2019-transportation-systems-backend

  - python_package_namespace: Namespace to use for project subpackages

    in public package authority, ex: hackoregon_transportation_systems

  - python_subpackage: Name of the Django Rest Framework subpackage for

    project code. Cookiecutter will generate a single subpackage, though

    project may have multiple subpackages

  - project_short_description: A brief description of the project

  - version: initial version of the app, should be 0.1.0 if new project

  - gis_project: Boolean as to whether to include

    django-restframework-gis package in setup.py dependencies

# Tests

To run tests on the Cookiecutter generation, please install TOX, which

is a generic virtualenv management and test command line tool.

TOX is available to install from PyPI via pip:

```

   $ pip install tox

```

It will automatically create a fresh virtual environment to run tests.

Then just run:

```

tox

```

# Development

To help contribute to the project:

* Open a github issue to track your Contribution

* Clone repo and create a feature BRANCH

* Make your changes

* Create passing tests in TOX

* Update Documentation

* Update Changelog with your changes, and add yourself to Contributors in contributors.md, if not already there.

* Create a PR using Pull request template (be sure to link to github issues)

* Receive at least 1 +1 from a project team member before merging.

* Profit