{"id":24911450,"url":"https://github.com/hackoregon/2019-sandbox-backend","last_synced_at":"2025-10-09T19:10:36.340Z","repository":{"id":57436573,"uuid":"187893946","full_name":"hackoregon/2019-sandbox-backend","owner":"hackoregon","description":"2019 Sandbox backend","archived":false,"fork":false,"pushed_at":"2019-12-11T04:13:46.000Z","size":382,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":21,"default_branch":"develop","last_synced_at":"2024-10-11T09:11:50.750Z","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":null,"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-21T18:37:57.000Z","updated_at":"2020-08-10T19:04:43.000Z","dependencies_parsed_at":"2022-09-10T01:51:39.973Z","dependency_job_id":null,"html_url":"https://github.com/hackoregon/2019-sandbox-backend","commit_stats":null,"previous_names":[],"tags_count":160,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-sandbox-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-sandbox-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-sandbox-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2F2019-sandbox-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackoregon","download_url":"https://codeload.github.com/hackoregon/2019-sandbox-backend/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245960812,"owners_count":20700781,"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:20:16.088Z","updated_at":"2025-10-09T19:10:31.304Z","avatar_url":"https://github.com/hackoregon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hackoregon_sandbox\n\n![PyPI version](https://badge.fury.io/py/2019-sandbox-backend.svg) | [![Build Status](https://travis-ci.org/hackoregon/2019-sandbox-backend.svg?branch=master)](https://travis-ci.org/hackoregon/2019-sandbox-backend)\n\n2019 Sandbox Backend\n\n# Documentation\n\nThe full documentation is at http://hackoregon.github.io/2019-sandbox-backend\n\n\n# Features\n\n\u003e -   TODO (add what your project does)\n\n# Data Sources\n\nThis API package in this repo is based on the Data Science work in the following projects:\n\n* [2019-sandbox-data-science](https://github.com/hackoregon/2019-sandbox-data-science)\n\n# Quickstart to install package in your own Django Project (Non-Hack Oregon Workflow)\n\n* Install hackoregon_sandbox:  \n  `pip install hackoregon_sandbox`\n\n* Add subpackages to your `INSTALLED_APPS`:\n\n  ```python\n  INSTALLED_APPS = [     \n                      ...     \n                      'api',     \n                      ...\n                    ]\n  ```\n\n* Add hackoregon_sandbox's URL patterns:\n\n  ```python\n  from hackoregon_sandbox.api\n  import urls as api_urls   \n\n  urlpatterns = [     \n                  ...     \n                  url(r'^', include(api_urls)),     \n                  ...\n                ]\n  ```\n\n* Setup your database with a matching schema\n\n* Run the project\n\n# Running Tests\n\nThis repo uses pytest and pytest-django to run tests.\n\nFor project development work, tests will be run in docker container\nusing the bin/test.sh script:\n\n# Deployment\n\nThis repo is intended to be used in conjunction with a Travis CI based automated deploy chain to push projects to an AWS Fargate cluster\n\nPrerequisites:\n\n* [bumpversion](https://github.com/peritus/bumpversion#installation) - install on local computer, used for version management\n\nBasic Steps:\n\n1. Branches can be pushed/merged in Github. Automated tests will be run. Unless a tagged push is made, app will not deploy\n2. When ready to deploy a new version, you'll confirm you have merged all latest code into your deployment branch (perhaps master?) and have this pulled to your local computer\n\n3. Create a tagged commit using bumpversion, following semantic versioning:\nv[major].[minor].[patch]\n\nLets take an example:\nIf the current version was `v1.10.4` and you wanted to update the minor portion (ie: a non-breaking but significant change), you will run the following command:\n\n```\nbumpversion minor --config-file ./hackoregon_sandbox/setup.cfg\n```\n\nthis would then update the version to `v1.11.0`\n\nto then create a patch update,\n\n```\nbumpversion patch --config-file ./hackoregon_sandbox/setup.cfg\n```\nVersion will then become: `v1.11.1`\n\nIn the background - `bumpversion` checks in the `setup.cfg` file for any `bumpversion:file` entries for which to regex for the version tag syntax, which in this case is the VERSION file which contains the current version. Bumpversion then looks at the part you specify and updates that portion accordingly\n\nAdditionally and importantly for the deploy chain, it will also add a `git tag` with the version number.\n\n4. Once you have created the new tagged version of your repo, you can go ahead and push a tagged release to github:\n\n```\ngit push origin \u003cversion-tag\u003e\n```\n5. Once you push this, Travis should run through it's testing/build cycle and then provided necessary env variables are configured in Travis and AWS services, deploy to the cloud.\n\n\n# Credits\n\nTools used in rendering this package:\n\n * [Cookiecutter](https://github.com/audreyr/cookiecutter)\n * [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackoregon%2F2019-sandbox-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackoregon%2F2019-sandbox-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackoregon%2F2019-sandbox-backend/lists"}