{"id":24911577,"url":"https://github.com/hackoregon/2019-backend-cookiecutter-django","last_synced_at":"2025-06-23T01:07:06.098Z","repository":{"id":38183363,"uuid":"184360297","full_name":"hackoregon/2019-backend-cookiecutter-django","owner":"hackoregon","description":"Cookiecutter template for creating a backend image","archived":false,"fork":false,"pushed_at":"2022-06-09T23:55:05.000Z","size":936,"stargazers_count":3,"open_issues_count":9,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-28T03:15:02.153Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackoregon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-01T02:40:27.000Z","updated_at":"2019-08-16T15:46:41.000Z","dependencies_parsed_at":"2022-08-31T09:01:21.837Z","dependency_job_id":null,"html_url":"https://github.com/hackoregon/2019-backend-cookiecutter-django","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/hackoregon/2019-backend-cookiecutter-django","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-backend-cookiecutter-django","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-backend-cookiecutter-django/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-backend-cookiecutter-django/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-backend-cookiecutter-django/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackoregon","download_url":"https://codeload.github.com/hackoregon/2019-backend-cookiecutter-django/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-backend-cookiecutter-django/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261392177,"owners_count":23151718,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-02T04:21:07.115Z","updated_at":"2025-06-23T01:07:01.084Z","avatar_url":"https://github.com/hackoregon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# backend-cookiecutter-django\n\n[![Build Status](https://travis-ci.org/hackoregon/2019-backend-cookiecutter-django.svg?branch=master)](https://travis-ci.org/hackoregon/2019-backend-cookiecutter-django)\n\nA cookiecutter template for creating reusable Django REST Framework\npackages with the best practices quickly. This template is customized to\nprovide structure for quickstarting a Hack Oregon civic data project.\n\n# What is Hack Oregon?\n\n[Hack Oregon](http://www.hackoregon.org/) is a rapid prototyping lab taking a creative approach to\ndata projects that bring insight to complex issues in the public\ninterest. We’re a community-powered nonprofit, our teams are made of\nvolunteers, and all the work we do is open source.\n\n# Features\n\n  - Pytest testing\n  - Sane setup.py for easy PyPI registration/distribution\n  - MIT Open Source Licensed\n  - Standard templates for README, issues and pull requests,\n    Contribution guidelines\n\n# Requirements\n\nThis repo uses the [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) templating project. You will need to\ninstall Cookiecutter. The recommended method is by a pip install:\n\n``` bash\n$ pip install cookiecutter\n```\n\n# Usage\n\nA more in-depth Training and User Guide is available [here](docs/training/TrainingGuide,pdf)\n\nTo generate a new repo:\n\n    $ cookiecutter gh:hackoregon/2019-backend-cookiecutter-django --checkout BRANCH\n\nYou can leave out the `--checkout BRANCH` if checking out from MASTER.\n\nYou'll be prompted for some questions, answer them, then it will create\na backend-cookiecutter-django with your new package.\n\nAt this point, you are ready to connect with an external git and start coding.\n\n## API Standards\n\nHack Oregon API developers should refer to our [Current API Standards Guide](docs/standards/v1/STANDARDS.md) for guidance on developing APIs for Hack Oregon.\n\n## Cookiecutter values\n\nYou will be asked the following information when creating a project:\n\n    {\n      \"full_name\": \"Your full name here\",\n      \"email\": \"you@example.com\",\n      \"github_username\": \"yourname\",\n      \"hack_oregon_team\": \"Transportation Systems\",\n      \"year\": \"2019\",\n      \"project_root_path\":\"transportation\",\n      \"github_repo\": \"2019-transportation-systems-backend\",\n      \"python_package_namespace\": \"hackoregon_transportation_systems\",\n      \"python_subpackage\": \"toad\",\n      \"project_short_description\": \"Your project description goes in here\",\n      \"version\": \"0.1.0\",\n      \"gis_project\": \"True\"\n    }\n\n## Explanation\n\n  - full_name: Your name as project originator (for credit in\n    documentation)\n  - email: Your email address\n  - github_username: Your github username\n  - hack_oregon_team: Canonical name for the Hack Oregon Project Team,\n  - year: Year project is worked on\n  - project_root_path - the url path project will be served on (after host name)\n    ie Transportation Systems or Sandbox\n  - github_repo: naming of repo within the hackoregon organization, ie:\n    2019-transportation-systems-backend\n  - python_package_namespace: Namespace to use for project subpackages\n    in public package authority, ex: hackoregon_transportation_systems\n  - python_subpackage: Name of the Django Rest Framework subpackage for\n    project code. Cookiecutter will generate a single subpackage, though\n    project may have multiple subpackages\n  - project_short_description: A brief description of the project\n  - version: initial version of the app, should be 0.1.0 if new project\n  - gis_project: Boolean as to whether to include\n    django-restframework-gis package in setup.py dependencies\n\n# Tests\n\nTo run tests on the Cookiecutter generation, please install TOX, which\nis a generic virtualenv management and test command line tool.\n\nTOX is available to install from PyPI via pip:\n\n```\n   $ pip install tox\n```\n\nIt will automatically create a fresh virtual environment to run tests.\n\nThen just run:\n\n\n```\ntox\n```\n\n# Development\n\nTo help contribute to the project:\n\n* Open a github issue to track your Contribution\n* Clone repo and create a feature BRANCH\n* Make your changes\n* Create passing tests in TOX\n* Update Documentation\n* Update Changelog with your changes, and add yourself to Contributors in contributors.md, if not already there.\n* Create a PR using Pull request template (be sure to link to github issues)\n* Receive at least 1 +1 from a project team member before merging.\n* Profit\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackoregon%2F2019-backend-cookiecutter-django","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackoregon%2F2019-backend-cookiecutter-django","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackoregon%2F2019-backend-cookiecutter-django/lists"}