https://github.com/julianwachholz/django-headstart

My personal flavor of a Django project template.
https://github.com/julianwachholz/django-headstart

django django-project-template python

Last synced: 5 days ago
JSON representation

My personal flavor of a Django project template.

• Host: GitHub
• URL: https://github.com/julianwachholz/django-headstart
• Owner: julianwachholz
• License: mit
• Created: 2013-07-01T16:23:46.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-03-05T23:14:47.000Z (over 9 years ago)
• Last Synced: 2024-10-18T06:14:53.321Z (26 days ago)
• Topics: django, django-project-template, python
• Language: Python
• Size: 223 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
#######################

Django project template

#######################

This is a Django project template. It uses several best practices from

all around the place and is optimized for use under Python 3. There

shouldn't be any problems with it under older Pythons, though.

The idea is that the project should be fully configurable with environment variables.

Additionally, I prefer putting project specific apps inside an 'apps' module, which

gives us a way to have a nicer project structure in general.

To use this template, call `startproject` like this::

    django-admin.py startproject --template=https://github.com/julianwachholz/django-project-template/archive/master.zip -e=py,rst,html,gitignore {{ project_name }}

Also you can or should probably remove this section from the README file after starting a project with this command.

##################

{{ project_name }}

##################

This is the README file for {{ project_name }}.

Quickstart

==========

You'll be able to start working on this project with the following prerequisites:

- Python 2.7+ or 3.3+

- Django 1.7+

- ``pip`` and ``virtualenv``

You can roughly follow these simple commands to get a running application::

    $ virtualenv {{ project_name }}-env

    $ source {{ project_name }}-env/bin/activate

    # Only required if you haven't setup your project yet. Remove these lines otherwise.

    $ pip install https://www.djangoproject.com/download/1.7b1/tarball/

    $ django-admin.py startproject --template=https://github.com/julianwachholz/django-project-template/archive/master.zip -e=py,rst,html {{ project_name }}

    $ # Append basic environment variables to environment setup

    $ echo "export DEBUG=1" >> {{ project_name }}-env/bin/activate

    $ echo "export PYTHONPATH=$PWD/{{ project_name }}" >> {{ project_name }}-env/bin/activate

    $ echo "export DJANGO_SETTINGS_MODULE={{ project_name }}.settings" >> {{ project_name }}-env/bin/activate

    $ source {{ project_name }}-env/bin/activate

    $ cd {{ project_name }}/

    $ pip install -r requirements.txt

    $ django-admin.py {migrate,runserver}

Of course, you'd want to setup a proper development environment.

Refer to the complete :doc:`docs/install` in this case.