wildfish / wildfish-django-starter

Django cookiecutter starter project template.

Wildfish Django Starter

A Django project cookiecutter template to kick start development for new projects. Includes apps and settings we use in the majority of projects, along with an integrated version of our other cookiecutter-django-crud template which will also generate a model, CRUD views and tests.

Features

• 2 tier layout
• Python essentials: ipython, ipdb, flake8
• Requirements file managed using pip-tools.
• Settings using django-configurations
• Testing bits: django-webtest, model-bakery
• Redis cache (via django-redis-cache)
• Sentry client, django-debug-toolbar
• django-model-utils
• Django CRUD views and templates using django-vanilla-views.
• A Django ModelForm using bootstrap3.
• Tests for all of the views using WebTest.
• Model Bakery generated models for the tests.

Quickstart

Ensure you have cookiecutter installed:

pip install cookiecutter

Then use cookiecutter to generate your project from this template with:

cookiecutter [email protected]:wildfish/wildfish-django-starter.git

Then from your generated project:

npm install

# TODO to be replaces/updated in docs ticket.
pip install -r requirements.in

python manage.py migrate

Requirements using pip-compile

The generated project uses a requirements.in file to make it straightforward to keep pinned requirements up to date using the pip-compile command from pip-tools.

To generate a requirements.txt from your project simply use the pip-compile command.

Read more here, https://github.com/nvie/pip-tools#example-usage-for-pip-compile

wildfish-django-starter's Issues

Add .editorconfig

Error python manage.py migrate

test:~/files/GitLab/new_geo/geometrika$ python manage.py migrate
Traceback (most recent call last):
  File "manage.py", line 9, in <module>
    from configurations.management import execute_from_command_line
  File "/usr/local/lib/python2.7/dist-packages/configurations/management.py", line 3, in <module>
    importer.install(check_options=True)
  File "/usr/local/lib/python2.7/dist-packages/configurations/importer.py", line 49, in install
    importer = ConfigurationImporter(check_options=check_options)
  File "/usr/local/lib/python2.7/dist-packages/configurations/importer.py", line 67, in __init__
    self.check_options()
  File "/usr/local/lib/python2.7/dist-packages/configurations/importer.py", line 85, in check_options
    parser = base.CommandParser(None,
AttributeError: 'module' object has no attribute 'CommandParser'

Blackify everything

To match Django.

Upgrade to Django 3

django 1.10 compatibility

git clone returned non-zero exit status 128

I was following the quickstart and I get the error below.

Am I doing something wrong?

albe@vamp398:/srv/dkr/532dkrcollection/534-cookiecutters/534c-wfish-local$ cookiecutter [email protected]:wildfish/wildfish-django-starter.git
The authenticity of host 'github.com (140.82.114.3)' can't be established.
RSA key fingerprint is SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8.
Are you sure you want to continue connecting (yes/no)? yes
Traceback (most recent call last):
  File "/home/albe/.local/bin/cookiecutter", line 11, in <module>
    sys.exit(main())
  File "/home/albe/.local/lib/python3.5/site-packages/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
  File "/home/albe/.local/lib/python3.5/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/home/albe/.local/lib/python3.5/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/albe/.local/lib/python3.5/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/home/albe/.local/lib/python3.5/site-packages/cookiecutter/cli.py", line 152, in main
    skip_if_file_exists=skip_if_file_exists,
  File "/home/albe/.local/lib/python3.5/site-packages/cookiecutter/main.py", line 74, in cookiecutter
    directory=directory,
  File "/home/albe/.local/lib/python3.5/site-packages/cookiecutter/repository.py", line 114, in determine_repo_dir
    no_input=no_input,
  File "/home/albe/.local/lib/python3.5/site-packages/cookiecutter/vcs.py", line 104, in clone
    stderr=subprocess.STDOUT,
  File "/usr/lib/python3.5/subprocess.py", line 626, in check_output
    **kwargs).stdout
  File "/usr/lib/python3.5/subprocess.py", line 708, in run
    output=stdout, stderr=stderr)
subprocess.CalledProcessError: Command '['git', 'clone', '[email protected]:wildfish/wildfish-django-starter.git']' returned non-zero exit status 128

Git Pull on Windows, checkout fails to create {{cookiecutter.model_name|lower}}_list.html

error: unable to create file {{cookiecutter.project_name}}/templates/{{cookiecutter.app_name}}/{{cookiecutter.model_name|lower}}_list.html (Invalid argument)
fatal: unable to checkout working tree
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry the checkout with 'git checkout -f HEAD'

Nothing after this: {{cookiecutter.project_name}}/templates/{{cookiecutter.app_name}} gets created.
Windows does not allow a pipe in a filename |.

{{cookiecutter.model_name|lower} is a no go in Windows.

Consider using Values, DatabaseURLValue and CacheURLValue from django-configurations

https://django-configurations.readthedocs.io/en/stable/values/

See if these give us anything and see if it's straightforward to get k8s to construct these as they're required.

Remove vanilla views

the installation instruction miss few things

Hi,

I tried to follow your installation instructions and it seems that python manage.py migrate crash on loading configuration module.

$ python manage.py migrate
Traceback (most recent call last):
File "manage.py", line 9, in
from configurations.management import execute_from_command_line
ImportError: No module named 'configurations'

If you intend this skeleton to be used by more ppl you might want to address the installation steps so this error does not appear.

I will look up how the configurations module works for django and post steps I had to do in order to get your project template to a working state. It might be useful for some other ppl that tries to use your template for the first time.

Check django 1.11 support.

Django 1.9 Support

Just waiting for berinhard/model_mommy#262