Skip to content

Various problems found in django-ida output #521

@timmc-edx

Description

@timmc-edx

I recently used the django-ida cookiecutter. Here are various problems I encountered that we should fix, some of which are in the django-ida cookiecutter and some of which are in the higher level python-template:

  • There are two versions of pull_translations, one old-style and a newer one using Atlas. See the OPENEDX_ATLAS_PULL in the Makefile. Atlas is no longer experimental, and now should be default, and the old pull_translations should be removed.
  • Remove devstack references and provisioning script
  • Remove Dockerfile and references (including docker-publish workflow)
  • Wrong Python version in tox reference -- should match Python version in tox.ini, and installed in workflow
  • Remove dependency on edx-django-release-util
  • Remove ALLOWED_HOSTS = ['*'] or add comment explaining why it is necessary. (This is a security issue.)
  • Remove requirements.txt
  • Remove PyPI publish workflow from django-ida template -- we don't publish IDAs to PyPI
  • Add make compile-requirements (see edx-platform)
  • Switch from PIP_COMPILE_OPTS to COMPILE_OPTS -- pip pays attention to all PIP_-prefixed env vars, and we should stay out of that namespace.
  • Allow chaining COMPILE_OPTS (accept extensions to it from command line)
  • Get rid of clean_tox (tox is supposed to clean itself)
  • Healthcheck docstring needs trailing slash on the sample call to avoid redirects
  • Healthcheck docstring shouldn't use edx.org example domain
  • Update default manage.py from Django's own template (I think that's https://github.com/django/django/blob/4.2.20/django/conf/project_template/manage.py-tpl) -- we've got an old one. Look into other things that should be updated around this as well.
  • Override CHANGELOG.rst to not have version strings in headings

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions