Skip to content
This repository was archived by the owner on Jun 15, 2021. It is now read-only.

Commit b5e6f18

Browse files
fmartingrfmartingr
committed
In the beggining there was darkness.
0 parents  commit b5e6f18

21 files changed

+398
-0
lines changed

‎.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Python
2+
*.pyc
3+
__pycache__
4+
5+
# PyPi
6+
dist/
7+
build/
8+
MANIFEST
9+
10+
# Emacs
11+
*~
12+
#*#
13+
14+
# Vim
15+
*.swp
16+
17+
# Unit tests
18+
.tox
19+
20+
# Virtualenvs
21+
.envs
22+
23+
# Database
24+
src/fragment/db.sqlite3

‎.travis.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
language: python
2+
sudo: false
3+
env:
4+
- TOX_ENV=py35-django19
5+
- TOX_ENV=py34-django19
6+
- TOX_ENV=py27-django19
7+
- TOX_ENV=py35-django110
8+
- TOX_ENV=py34-django110
9+
- TOX_ENV=py27-django110
10+
- TOX_ENV=py35-django111
11+
- TOX_ENV=py34-django111
12+
- TOX_ENV=py27-django111
13+
matrix:
14+
fast_finish: true
15+
allow_failures:
16+
- env: TOX_ENV=py27-django111
17+
- env: TOX_ENV=py34-django111
18+
- env: TOX_ENV=py35-django111
19+
install:
20+
# Virtualenv < 14 for python 3.2 build
21+
- pip install tox "virtualenv<14"
22+
script:
23+
- tox -e $TOX_ENV
24+
notifications:
25+
email: false

‎AUTHORS.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- Felipe Martin ([email protected])

‎CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Change log
2+
==========
3+
4+
# Next release
5+
6+
- Initial project configuration.
7+
- Added tox to execute unit tests.
8+
- Added Travis-CI support.
9+
- Added helper scripts `runserver` and `setuplocal` to ease the local development.

‎CONTRIBUTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Contributing guide
2+
==================
3+
4+
# Running the project locally
5+
## Setup local development environment
6+
7+
Execute the script as follows:
8+
9+
```
10+
$ scripts/setuplocal.sh
11+
```
12+
13+
- Creates a folder for the python virtual environments.
14+
- Create a main virtualenv for the developer to use.
15+
- Install the local requirements from `requirements/local.txt`.
16+
- Updates pip and setuptools.
17+
- Migrates the database
18+
19+
## Run a local copy of the project
20+
21+
Execute the script as follows:
22+
23+
```
24+
$ scripts/runserver.sh
25+
```
26+
27+
This just enables the virtualenv and executes `python src/manage.py runserver 0.0.0.0:8082`.

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2016 Felipe Martin
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Fragment
2+
========
3+
4+
Summary of the project
5+
6+
> :warning: *Work in progress*
7+
8+
# Installation
9+
10+
...
11+
12+
# Usage
13+
14+
...
15+
16+
# License
17+
18+
[LICENSE](LICENSE)
19+
20+
# Contributing
21+
22+
[CONTRIBUTING.md](CONTRIBUTING.md)

‎requirements/base.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Django
2+
django>=1.10.0,<1.10.99

‎requirements/local.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
-r base.txt

‎requirements/test.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
-r base.txt
2+
3+
# ipython debugger
4+
ipdb>=0.10.0,<0.10.99

‎runtests.py

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# TODO

‎scripts/runserver.sh

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#!/bin/bash
2+
3+
# If we're cd'd on the scripts directory we just need to
4+
# use the parent directory as base path.
5+
# Otherwise the current path it's ok if you didn't execute
6+
# this from weird places.
7+
BASE_PATH="./"
8+
if [ $(pwd) == *scripts* ]; then
9+
BASE_PATH="../"
10+
fi
11+
12+
# Activate the virtualev
13+
source ${BASE_PATH}.envs/py35/bin/activate
14+
15+
# Runserver!
16+
python ${BASE_PATH}src/manage.py runserver 0.0.0.0:8082
17+
18+
# Deactivate the virtualenv
19+
deactivate

‎scripts/setuplocal.sh

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#!/bin/bash -e
2+
3+
# If we're cd'd on the scripts directory we just need to
4+
# use the parent directory as base path.
5+
# Otherwise the current path it's ok if you didn't execute
6+
# this from weird places.
7+
BASE_PATH="./"
8+
if [ $(pwd) == *scripts* ]; then
9+
BASE_PATH="../"
10+
fi
11+
12+
# Create a hidden directory for the python virtualenvs
13+
echo "=> Check for virualenvs directory"
14+
if [ ! -d "${BASE_PATH}.envs" ]; then
15+
mkdir ${BASE_PATH}.envs
16+
fi
17+
18+
# Generate a virtualenv
19+
echo "=> Create virtualenv"
20+
if [ ! -d "${BASE_PATH}.envs/py35" ]; then
21+
virtualenv -p python3.5 ${BASE_PATH}.envs/py35
22+
fi
23+
24+
# Activate the virtualenv
25+
source $BASE_PATH.envs/py35/bin/activate
26+
27+
echo "=> Update base packages for the virtualenv"
28+
pip install -U pip setuptools
29+
30+
# Install the requirements
31+
echo "=> Install requirements"
32+
pip install -r $BASE_PATH/requirements/local.txt
33+
34+
# Execute django commands
35+
echo "=> Doing django migrations"
36+
python src/manage.py migrate
37+
38+
# Deactivates the virtualenv
39+
deactivate

‎src/fragment/__init__.py

Whitespace-only changes.

‎src/fragment/settings/__init__.py

Whitespace-only changes.

‎src/fragment/settings/base.py

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
"""
2+
Django settings for fragment project.
3+
4+
Generated by 'django-admin startproject' using Django 1.10.3.
5+
6+
For more information on this file, see
7+
https://docs.djangoproject.com/en/1.10/topics/settings/
8+
9+
For the full list of settings and their values, see
10+
https://docs.djangoproject.com/en/1.10/ref/settings/
11+
"""
12+
13+
import os
14+
15+
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
16+
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
17+
18+
19+
# Quick-start development settings - unsuitable for production
20+
# See https://docs.djangoproject.com/en/1.10/howto/deployment/checklist/
21+
22+
# SECURITY WARNING: keep the secret key used in production secret!
23+
SECRET_KEY = 'x)x374l2m#8c40%-+dos4orpvh$r%e8&5)dxg5i$*(*@a+!$r@'
24+
25+
# SECURITY WARNING: don't run with debug turned on in production!
26+
DEBUG = True
27+
28+
ALLOWED_HOSTS = []
29+
30+
31+
# Application definition
32+
33+
INSTALLED_APPS = [
34+
'django.contrib.admin',
35+
'django.contrib.auth',
36+
'django.contrib.contenttypes',
37+
'django.contrib.sessions',
38+
'django.contrib.messages',
39+
'django.contrib.staticfiles',
40+
]
41+
42+
MIDDLEWARE = [
43+
'django.middleware.security.SecurityMiddleware',
44+
'django.contrib.sessions.middleware.SessionMiddleware',
45+
'django.middleware.common.CommonMiddleware',
46+
'django.middleware.csrf.CsrfViewMiddleware',
47+
'django.contrib.auth.middleware.AuthenticationMiddleware',
48+
'django.contrib.messages.middleware.MessageMiddleware',
49+
'django.middleware.clickjacking.XFrameOptionsMiddleware',
50+
]
51+
52+
ROOT_URLCONF = 'fragment.urls'
53+
54+
TEMPLATES = [
55+
{
56+
'BACKEND': 'django.template.backends.django.DjangoTemplates',
57+
'DIRS': [],
58+
'APP_DIRS': True,
59+
'OPTIONS': {
60+
'context_processors': [
61+
'django.template.context_processors.debug',
62+
'django.template.context_processors.request',
63+
'django.contrib.auth.context_processors.auth',
64+
'django.contrib.messages.context_processors.messages',
65+
],
66+
},
67+
},
68+
]
69+
70+
WSGI_APPLICATION = 'fragment.wsgi.application'
71+
72+
73+
# Database
74+
# https://docs.djangoproject.com/en/1.10/ref/settings/#databases
75+
76+
DATABASES = {
77+
'default': {
78+
'ENGINE': 'django.db.backends.sqlite3',
79+
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
80+
}
81+
}
82+
83+
84+
# Password validation
85+
# https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators
86+
87+
AUTH_PASSWORD_VALIDATORS = [
88+
{
89+
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
90+
},
91+
{
92+
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
93+
},
94+
{
95+
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
96+
},
97+
{
98+
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
99+
},
100+
]
101+
102+
103+
# Internationalization
104+
# https://docs.djangoproject.com/en/1.10/topics/i18n/
105+
106+
LANGUAGE_CODE = 'en-us'
107+
108+
TIME_ZONE = 'UTC'
109+
110+
USE_I18N = True
111+
112+
USE_L10N = True
113+
114+
USE_TZ = True
115+
116+
117+
# Static files (CSS, JavaScript, Images)
118+
# https://docs.djangoproject.com/en/1.10/howto/static-files/
119+
120+
STATIC_URL = '/static/'

‎src/fragment/settings/local.py

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
from .base import * # noqa
2+
3+
# Secret key
4+
SECRET_KEY = '0123456789'

‎src/fragment/urls.py

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
"""fragment URL Configuration
2+
3+
The `urlpatterns` list routes URLs to views. For more information please see:
4+
https://docs.djangoproject.com/en/1.10/topics/http/urls/
5+
Examples:
6+
Function views
7+
1. Add an import: from my_app import views
8+
2. Add a URL to urlpatterns: url(r'^$', views.home, name='home')
9+
Class-based views
10+
1. Add an import: from other_app.views import Home
11+
2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home')
12+
Including another URLconf
13+
1. Import the include() function: from django.conf.urls import url, include
14+
2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls'))
15+
"""
16+
from django.conf.urls import url
17+
from django.contrib import admin
18+
19+
urlpatterns = [
20+
url(r'^admin/', admin.site.urls),
21+
]

‎src/fragment/wsgi.py

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
WSGI config for fragment project.
3+
4+
It exposes the WSGI callable as a module-level variable named ``application``.
5+
6+
For more information on this file, see
7+
https://docs.djangoproject.com/en/1.10/howto/deployment/wsgi/
8+
"""
9+
10+
import os
11+
12+
from django.core.wsgi import get_wsgi_application
13+
14+
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "fragment.settings.local")
15+
16+
application = get_wsgi_application()

‎src/manage.py

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#!/usr/bin/env python
2+
import os
3+
import sys
4+
5+
if __name__ == "__main__":
6+
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "fragment.settings.local")
7+
try:
8+
from django.core.management import execute_from_command_line
9+
except ImportError:
10+
# The above import may fail for some other reason. Ensure that the
11+
# issue is really that Django is missing to avoid masking other
12+
# exceptions on Python 2.
13+
try:
14+
import django
15+
except ImportError:
16+
raise ImportError(
17+
"Couldn't import Django. Are you sure it's installed and "
18+
"available on your PYTHONPATH environment variable? Did you "
19+
"forget to activate a virtual environment?"
20+
)
21+
raise
22+
execute_from_command_line(sys.argv)

0 commit comments

Comments
 (0)