Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ietf-tools/ietf-guides
A small django project to help match IETF guide program guides to participants
https://github.com/ietf-tools/ietf-guides
django guide ietf python
Last synced: about 2 months ago
JSON representation
A small django project to help match IETF guide program guides to participants
- Host: GitHub
- URL: https://github.com/ietf-tools/ietf-guides
- Owner: ietf-tools
- License: bsd-3-clause
- Created: 2019-02-05T17:20:59.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T14:21:19.000Z (3 months ago)
- Last Synced: 2024-10-23T16:50:41.080Z (3 months ago)
- Topics: django, guide, ietf, python
- Language: Python
- Homepage:
- Size: 161 KB
- Stars: 2
- Watchers: 5
- Forks: 11
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ietf-tools/ietf-guides/releases)
[](https://github.com/ietf-tools/ietf-guides/blob/main/LICENSE)
[](https://github.com/ietf-tools/ietf-guides/pkgs/container/ietf-guides)
##### A small django project to help match IETF guide program guides to participants
- [Setup for a development environment](#setup-for-a-development-environment)
- [Running a prebuilt image under docker](#running-a-prebuilt-image-under-docker)
- [Dummy Data](#dummy-data)
- [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md)
---
### Setup for a development environment
* check out a working copy
* create and activate a python3 virtualenv
```bash
virtualenv --python=python 3 .
. bin/activate
pip install -r requirements.txt
```
* set up a database and a user that has all privileges with it.
* create ietf_guides/settings/local.py and add values for
- `SECRET_KEY` (this is the usual django SECRET_KEY)
- `HASHSALT` (some short string - see [guides/utils.py](guides/utils.py) for how this is used)
- `DEFAULT_FROM_EMAIL`
- `DATABASES` (a dict matching the database you set up above)
Some possible DATABASE dicts:
```python
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
DATABASES = {
'default': {
'NAME': 'ietf_guides',
'ENGINE': 'django.db.backends.mysql',
'USER': ,
'PASSWORD': ,
'OPTIONS': {'init_command': "SET sql_mode='STRICT_TRANS_TABLES'"},
},
}
```
* 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
* `./manage.py migrate`
* `./manage.py test --settings=ietf_guides.settings.test`
* `./manage.py createsuperuser`
### Running a prebuilt image under docker
* set up a database and a user that has all privileges with it
* create a run directory outside any clone of the source
* create a `local.py` in that directory as above
* start the most recent image from mapping your `local.py` and possibly your database socket into the container using a command similar to:
```bash
docker 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
```
or perhaps
```bash
docker 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
```
The website will then be exposed at http://localhost:8002
### Dummy data
running `./manage.py make_dummy_data` will create ten guides and ten participants with field values populated by Faker.