Rename project (prepare to 0.1)

This commit is contained in:
Yohan Boniface 2013-01-02 15:49:20 +01:00
parent 19e124d273
commit e6bf339c54
40 changed files with 44 additions and 453 deletions

4
.gitignore vendored
View file

@ -1,5 +1,5 @@
*.pyc
*.egg-info
youmap/settings/local.py
youmap/settings/local/*
umap/settings/local.py
umap/settings/local/*
docs/_build

View file

@ -1,9 +1,9 @@
YouMap project
uMap project
==============
About
-----
YouMap let you create map with OpenStreetMap layers in a minute and embed them in your site.
uMap let you create map with OpenStreetMap layers in a minute and embed them in your site.
*Be cause we think that the more OSM will be used, the more OSM will be ''cured''.*
It uses `django-leaflet-storage <https://github.com/yohanboniface/django-leaflet-storage>`_ and `Leaflet.Storage <https://github.com/yohanboniface/Leaflet.Storage>`_, built on top of Django and Leaflet.
@ -15,24 +15,24 @@ Create a geo aware database. See `Geodjango doc <https://docs.djangoproject.com/
Create a virtualenv::
mkvirtualenv youmap
mkvirtualenv umap
Install dependencies and project::
cd path/to/youmap/repository
cd path/to/umap/repository
pip install -r requirements.pip
pip install -e .
Create a default local settings file::
touch youmap/settings/local.py
touch umap/settings/local.py
Add database connexion informations in `local.py`, for example::
DATABASES = {
'default': {
'ENGINE': 'django.contrib.gis.db.backends.postgis',
'NAME': 'youmap',
'NAME': 'umap',
}
}

View file

@ -1,88 +0,0 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf _build/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
@echo
@echo "Build finished. The HTML pages are in _build/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
@echo
@echo "Build finished. The HTML pages are in _build/dirhtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in _build/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in _build/qthelp, like this:"
@echo "# qcollectiongenerator _build/qthelp/project.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile _build/qthelp/project.qhc"
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
@echo
@echo "Build finished; the LaTeX files are in _build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
@echo
@echo "The overview file is in _build/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in _build/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in _build/doctest/output.txt."

View file

@ -1,195 +0,0 @@
# -*- coding: utf-8 -*-
#
# youmap documentation build configuration file, created by
# sphinx-quickstart on Wed Aug 19 10:27:46 2009.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
import datetime
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.append(os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'youmap'
copyright = u'%d, myauthor' % datetime.date.today().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
#unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_use_modindex = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'youmapdoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'youmap.tex', u'youmap Documentation',
u'myauthor', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_use_modindex = True

View file

@ -1,28 +0,0 @@
Deployment
==========
Staging/Development
-------------------
`Fabric <http://pypi.python.org/pypi/Fabric>`_ is used to allow developers to
easily push changes to a previously setup development/staging environment.
To get started, install Fabric by running the following command from within
your virtual environment::
pip install fabric==1.4
So see a list of available commands, run the following command from within your
project directory::
fab -l
Some common commands::
fab restart # Restart the web server.
fab update # Just update the repository.
fab push deploy # Push, then fully deploy.
From the within the project directory, you can just run ``fab [command]``.
If you want to run fabric outside of the directory, use::
fab --fabfile /path/to/project/fabfile.py [command]

View file

@ -1,17 +0,0 @@
==================
Environments
==================
When deploying to multiple environments (development, staging, production, etc.), you'll likely want to deploy different configurations. Each environment/configuration should have its own file in ``youmap/settings`` and inherit from ``youmap.settings.base``. A ``dev`` environment is provided as an example.
By default, ``manage.py`` and ``wsgi.py`` will use ``youmap.settings.local`` if no settings module has been defined. To override this, use the standard Django constructs (setting the ``DJANGO_SETTINGS_MODULE`` environment variable or passing in ``--settings=youmap.settings.<env>``). Alternatively, you can symlink your environment's settings to ``youmap/settings/local.py``.
You may want to have different ``wsgi.py`` and ``urls.py`` files for different environments as well. If so, simply follow the directory structure laid out by ``youmap/settings``, for example::
wsgi/
__init__.py
base.py
dev.py
...
The settings files have examples of how to point Django to these specific environments.

View file

@ -1,19 +0,0 @@
Welcome to youmap's documentation!
=====================================
Contents:
.. toctree::
:maxdepth: 2
install
environments
deployment
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View file

@ -1,57 +0,0 @@
==================
Installation
==================
Pre-Requisites
===============
* `setuptools <http://pypi.python.org/pypi/setuptools>`_
* `virtualenv <http://pypi.python.org/pypi/virtualenv>`_
To install all of these system dependencies on a Debian-based system, run::
sudo apt-get install python-setuptools
sudo easy_install virtualenv
Creating the Virtual Environment
================================
First, create a clean base environment using virtualenv::
virtualenv youmap
cd youmap
source bin/activate
Installing the Project
======================
Install the requirements and the project source::
cd path/to/your/youmap/repository
pip install -r requirements.pip
pip install -e .
Configuring a Local Environment
===============================
If you're just checking the project out locally, you can copy some example
configuration files to get started quickly::
cp youmap/settings/local.py.example youmap/settings/local.py
manage.py syncdb --migrate
Building Documentation
======================
Documentation is available in ``docs`` and can be built into a number of
formats using `Sphinx <http://pypi.python.org/pypi/Sphinx>`_. To get started::
pip install Sphinx
cd docs
make html
This creates the documentation in HTML format at ``docs/_build/html``.

6
fabfile.py vendored
View file

@ -3,8 +3,8 @@ from fabric.api import task, env, run, local, roles, cd, execute, hide, puts,\
import posixpath
env.project_name = 'youmap'
env.repository = 'https://yohanboniface@bitbucket.org/yohanboniface/youmap_project.git'
env.project_name = 'umap'
env.repository = 'https://yohanboniface@bitbucket.org/yohanboniface/umap.git'
env.local_branch = 'master'
env.remote_ref = 'origin/master'
env.requirements_file = 'requirements.pip'
@ -20,7 +20,7 @@ def live():
"""
Use the live deployment environment.
"""
server = 'youmap.org'
server = 'umap.org'
env.roledefs = {
'web': [server],
'db': [server],

View file

@ -4,7 +4,7 @@ import sys
if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE",
"youmap.settings.local")
"umap.settings.local")
from django.core.management import execute_from_command_line

View file

@ -5,19 +5,19 @@ import codecs
from setuptools import setup, find_packages
import youmap
import umap
long_description = codecs.open('README.rst', "r", "utf-8").read()
setup(
name="youmap",
version=youmap.__version__,
author=youmap.__author__,
author_email=youmap.__contact__,
description=youmap.__doc__,
name="umap",
version=umap.__version__,
author=umap.__author__,
author_email=umap.__contact__,
description=umap.__doc__,
keywords="django leaflet geodjango openstreetmap",
url=youmap.__homepage__,
download_url="https://bitbucket.org/yohanboniface/youmap_project/downloads",
url=umap.__homepage__,
download_url="https://bitbucket.org/yohanboniface/umap/downloads",
packages=find_packages(),
include_package_data=True,
platforms=["any"],

View file

@ -1,7 +1,7 @@
"Create maps with OpenStreetMap layers in a minute and embed them in your site."
VERSION = (0, 0, 1)
VERSION = (0, 0, 8)
__author__ = 'Yohan Boniface'
__contact__ = "yb@enix.org"
__homepage__ = "https://bitbucket.org/yohanboniface/youmap_project"
__homepage__ = "https://bitbucket.org/yohanboniface/umap"
__version__ = ".".join(map(str, VERSION))

View file

@ -31,7 +31,7 @@ INSTALLED_APPS = (
'leaflet_storage',
'foundation',
'endless_pagination',
'youmap',
'umap',
'sesql',
'compressor',
@ -54,7 +54,7 @@ INSTALLED_APPS = (
import os
import sys
import youmap as project_module
import umap as project_module
PROJECT_DIR = os.path.dirname(os.path.realpath(project_module.__file__))
@ -81,7 +81,7 @@ if not os.path.exists(VAR_ROOT):
# Project URLS and media settings
#==============================================================================
ROOT_URLCONF = 'youmap.urls'
ROOT_URLCONF = 'umap.urls'
LOGIN_URL = '/login/'
LOGOUT_URL = '/logout/'

View file

@ -1,20 +1,16 @@
"""Settings for Development Server"""
from youmap.settings.base import * # pylint: disable=W0614,W0401
from umap.settings.base import * # pylint: disable=W0614,W0401
DEBUG = True
TEMPLATE_DEBUG = DEBUG
VAR_ROOT = '/var/www/youmap'
VAR_ROOT = '/var/www/umap'
MEDIA_ROOT = os.path.join(VAR_ROOT, 'uploads')
STATIC_ROOT = os.path.join(VAR_ROOT, 'static')
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': 'youmap',
# 'USER': 'dbuser',
# 'PASSWORD': 'dbpassword',
'NAME': 'umap',
}
}
# WSGI_APPLICATION = 'youmap.wsgi.dev.application'

View file

@ -1,4 +1,4 @@
{% extends "youmap/home.html" %}
{% extends "umap/home.html" %}
{% block content %}
<div class="row">
@ -6,7 +6,7 @@
<!-- Navigation -->
{% include 'youmap/navigation.html' %}
{% include 'umap/navigation.html' %}
<!-- End Navigation -->
</div>

View file

@ -7,7 +7,7 @@
{% compress css %}
<!-- Included CSS Files (Compressed) -->
<link rel="stylesheet" href="{{ STATIC_URL }}foundation/stylesheets/foundation.css">
<link rel="stylesheet" href="{{ STATIC_URL }}youmap/youmap.css">
<link rel="stylesheet" href="{{ STATIC_URL }}umap/umap.css">
<script src="{{ STATIC_URL }}foundation/javascripts/modernizr.foundation.js"></script>
{% endcompress css %}

View file

@ -1,4 +1,4 @@
{% load youmap_tags i18n %}
{% load umap_tags i18n %}
<form action="{{ action_url }}" method="post" id="category_edit">
{% csrf_token %}
{% for error in form.errors %}

View file

@ -1,4 +1,4 @@
{% load youmap_tags i18n %}
{% load umap_tags i18n %}
<form method="post" action="{{ action }}" id="feature_form" onsubmit="return false;">
{% csrf_token %}
{{ form.no_field_errors }}

View file

@ -1,4 +1,4 @@
{% load youmap_tags i18n %}
{% load umap_tags i18n %}
{% if not map %}
<h3>{% trans "Create your map now!" %}</h3>
{% endif %}

View file

@ -17,7 +17,7 @@
<!-- Navigation -->
{% include 'youmap/navigation.html' %}
{% include 'umap/navigation.html' %}
<!-- End Navigation -->
</div>
@ -63,7 +63,7 @@
</div>
</a>
<a href="https://bitbucket.org/yohanboniface/youmap_project">
<a href="https://bitbucket.org/yohanboniface/umap_project">
<div class="panel radius callout" align="center">
<strong>{% trans "Fork it" %}</strong>
</div>
@ -109,7 +109,7 @@
<div class="six columns">
<ul class="link-list right">
<li><a href="#TODO">About</a></li>
<li><a href="https://bitbucket.org/yohanboniface/youmap_project">Fork me</a></li>
<li><a href="https://bitbucket.org/yohanboniface/umap_project">Fork me</a></li>
<li><a href="#">Link 3</a></li>
<li><a href="#">Link 4</a></li>
</ul>

View file

@ -1,4 +1,4 @@
{% extends "youmap/home.html" %}
{% extends "umap/home.html" %}
{% load i18n %}
@ -8,7 +8,7 @@
<!-- Navigation -->
{% include 'youmap/navigation.html' %}
{% include 'umap/navigation.html' %}
<!-- End Navigation -->
</div>

View file

@ -3,7 +3,7 @@ from django import template
register = template.Library()
@register.inclusion_tag('youmap/field.html')
@register.inclusion_tag('umap/field.html')
def foundation_field(field):
return {
'field': field,

View file

@ -10,7 +10,6 @@ from . import views
admin.autodiscover()
urlpatterns = patterns('',
# (r'', include('youmap.apps.')),
(r'^admin/doc/', include('django.contrib.admindocs.urls')),
(r'^admin/', include(admin.site.urls)),
url(r'^$', views.home, name="home"),

View file

@ -9,7 +9,7 @@ from leaflet_storage.models import Map
class Home(TemplateView):
template_name = "youmap/home.html"
template_name = "umap/home.html"
list_template_name = "leaflet_storage/map_list.html"
def get_context_data(self, **kwargs):
@ -59,7 +59,7 @@ user_maps = UserMaps.as_view()
class Search(TemplateView):
template_name = "youmap/search.html"
template_name = "umap/search.html"
list_template_name = "leaflet_storage/map_list.html"
def get_context_data(self, **kwargs):

View file

@ -1,5 +1,5 @@
"""
WSGI config for youmap project.
WSGI config for umap project.
This module contains the WSGI application used by Django's development server
and any production WSGI deployments. It should expose a module-level variable
@ -16,7 +16,7 @@ framework.
import os
os.environ.setdefault("DJANGO_SETTINGS_MODULE",
"youmap.settings.local")
"umap.settings.local")
# This application object is used by any WSGI server configured to use this
# file. This includes Django's development server, if the WSGI_APPLICATION