{"id":22832769,"url":"https://github.com/ietf-tools/ietf-guides","last_synced_at":"2025-04-23T21:25:36.823Z","repository":{"id":37791730,"uuid":"169280738","full_name":"ietf-tools/ietf-guides","owner":"ietf-tools","description":"A small django project to help match IETF guide program guides to participants","archived":false,"fork":false,"pushed_at":"2024-10-23T14:21:19.000Z","size":165,"stargazers_count":2,"open_issues_count":10,"forks_count":11,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-23T16:50:41.080Z","etag":null,"topics":["django","guide","ietf","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ietf-tools.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-05T17:20:59.000Z","updated_at":"2024-10-23T14:21:23.000Z","dependencies_parsed_at":"2022-06-23T20:04:53.571Z","dependency_job_id":"4efc84df-b469-486a-8016-78bc7b569b86","html_url":"https://github.com/ietf-tools/ietf-guides","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ietf-tools%2Fietf-guides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ietf-tools%2Fietf-guides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ietf-tools%2Fietf-guides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ietf-tools%2Fietf-guides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ietf-tools","download_url":"https://codeload.github.com/ietf-tools/ietf-guides/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250516097,"owners_count":21443553,"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":["django","guide","ietf","python"],"created_at":"2024-12-12T21:09:12.648Z","updated_at":"2025-04-23T21:25:36.804Z","avatar_url":"https://github.com/ietf-tools.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \n\u003cimg src=\"https://raw.githubusercontent.com/ietf-tools/common/main/assets/logos/ietf-guides.svg\" alt=\"IETF Guides\" height=\"125\" /\u003e\n    \n[![Release](https://img.shields.io/github/release/ietf-tools/ietf-guides.svg?style=flat\u0026maxAge=600)](https://github.com/ietf-tools/ietf-guides/releases)\n[![License](https://img.shields.io/github/license/ietf-tools/ietf-guides)](https://github.com/ietf-tools/ietf-guides/blob/main/LICENSE)\n[![GitHub Packages](https://img.shields.io/badge/GitHub%20Packages-Docker%20Images-blue?logo=github)](https://github.com/ietf-tools/ietf-guides/pkgs/container/ietf-guides)\n\u003c!-- [![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/ietf-tools/ietf-guides) --\u003e\n    \n##### A small django project to help match IETF guide program guides to participants\n    \n\u003c/div\u003e\n\n- [Setup for a development environment](#setup-for-a-development-environment)\n- [Running a prebuilt image under docker](#running-a-prebuilt-image-under-docker)\n- [Dummy Data](#dummy-data)\n- [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md)\n\n---\n\n### Setup for a development environment\n* check out a working copy\n* create and activate a python3 virtualenv\n  ```bash\n  virtualenv --python=python 3 .\n  . bin/activate\n  pip install -r requirements.txt\n  ```\n* set up a database and a user that has all privileges with it.\n* create ietf_guides/settings/local.py and add values for\n  - `SECRET_KEY`   (this is the usual django SECRET_KEY)\n  - `HASHSALT`     (some short string - see [guides/utils.py](guides/utils.py) for how this is used)\n  - `DEFAULT_FROM_EMAIL`\n  - `DATABASES`    (a dict matching the database you set up above)\n\nSome possible DATABASE dicts:\n```python\n\nDATABASES = {\n    'default': {\n        'ENGINE': 'django.db.backends.sqlite3',\n        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),\n    }\n}\n\nDATABASES = {\n    'default': {\n        'NAME': 'ietf_guides',\n        'ENGINE': 'django.db.backends.mysql',\n        'USER': \u003cyour db user\u003e,\n        'PASSWORD': \u003cyour db password\u003e,\n        'OPTIONS': {'init_command': \"SET sql_mode='STRICT_TRANS_TABLES'\"},\n    },\n}\n```\n* export which settings you want to use as `DJANGO_SETTINGS_MODULE` (e.g. `ietf_guides.settings.dev`) or supply settings on the command line as necessary\n* `./manage.py migrate`\n* `./manage.py test --settings=ietf_guides.settings.test`\n* `./manage.py createsuperuser`\n\n### Running a prebuilt image under docker\n* set up a database and a user that has all privileges with it\n* create a run directory outside any clone of the source\n* create a `local.py` in that directory as above\n* start the most recent image from \u003chttps://cloud.docker.com/u/ietf/repository/docker/ietf/ietf_guides\u003e mapping your `local.py` and possibly your database socket into the container using a command similar to:\n```bash\ndocker run -it -v ${PWD}/logs:/code/logs -v ${PWD}/local.py:/code/ietf_guides/settings/local.py -p 8002:80 --name ietf-guides ghcr.io/ietf-tools/ietf-guides:latest\n```\nor perhaps\n\n```bash\ndocker run -it -v ${PWD}/logs:/code/logs -v ${PWD}/secrets/local.py:/code/ietf_guides/settings/local.py -v /var/run/mysql:/var/run/mysql -p 8002:80 --name ietf-guides ghcr.io/ietf-tools/ietf-guides:latest\n```\nThe website will then be exposed at http://localhost:8002\n\n### Dummy data\nrunning `./manage.py make_dummy_data` will create ten guides and ten participants with field values populated by Faker.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fietf-tools%2Fietf-guides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fietf-tools%2Fietf-guides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fietf-tools%2Fietf-guides/lists"}