diff --git a/etiquette/constants.py b/etiquette/constants.py index 6c8b343..2f96e43 100644 --- a/etiquette/constants.py +++ b/etiquette/constants.py @@ -1,7 +1,6 @@ ''' This file provides data and objects that do not change throughout the runtime. ''' - import converter import logging import shutil diff --git a/etiquette/helpers.py b/etiquette/helpers.py index bd60d1a..a952c25 100644 --- a/etiquette/helpers.py +++ b/etiquette/helpers.py @@ -2,7 +2,6 @@ This file provides functions which are used in various places throughout the codebase but don't deserve to be methods of any class. ''' - import datetime import hashlib import math @@ -12,12 +11,12 @@ import PIL.Image import unicodedata import zipstream -from . import constants -from . import exceptions - from voussoirkit import bytestring from voussoirkit import pathclass +from . import constants +from . import exceptions + def album_as_directory_map(album, recursive=True): ''' Given an album, produce a dictionary mapping Album objects to directory @@ -499,11 +498,12 @@ def truthystring(s): def zip_album(album, recursive=True): ''' Given an album, return a zipstream zipfile that contains the album's - photos (recursive = include childen's photos) organized into folders + photos (recursive = include children's photos) organized into folders for each album. Each album folder also gets a text file containing the album's name and description if applicable. If an album is a child of multiple albums, only one instance is used. + If a photo appears in multiple albums, only one instance is used. ''' zipfile = zipstream.ZipFile() diff --git a/etiquette/objects.py b/etiquette/objects.py index bfbf23a..2c593e7 100644 --- a/etiquette/objects.py +++ b/etiquette/objects.py @@ -2,21 +2,20 @@ This file provides the data objects that should not be instantiated directly, but are returned by the PDB accesses. ''' - import os import PIL.Image import string import traceback +from voussoirkit import bytestring +from voussoirkit import pathclass +from voussoirkit import spinal + from . import constants from . import decorators from . import exceptions from . import helpers -from voussoirkit import bytestring -from voussoirkit import pathclass -from voussoirkit import spinal - class ObjectBase: def __init__(self, photodb): diff --git a/etiquette/photodb.py b/etiquette/photodb.py index f3c8acc..8318ef7 100644 --- a/etiquette/photodb.py +++ b/etiquette/photodb.py @@ -9,6 +9,13 @@ import string import tempfile import time +from voussoirkit import cacheclass +from voussoirkit import expressionmatch +from voussoirkit import pathclass +from voussoirkit import ratelimiter +from voussoirkit import spinal +from voussoirkit import sqlhelpers + from . import constants from . import decorators from . import exceptions @@ -17,13 +24,6 @@ from . import objects from . import searchhelpers from . import tag_export -from voussoirkit import cacheclass -from voussoirkit import expressionmatch -from voussoirkit import pathclass -from voussoirkit import ratelimiter -from voussoirkit import spinal -from voussoirkit import sqlhelpers - logging.basicConfig() diff --git a/etiquette/searchhelpers.py b/etiquette/searchhelpers.py index 4354f1a..c6c918f 100644 --- a/etiquette/searchhelpers.py +++ b/etiquette/searchhelpers.py @@ -3,7 +3,6 @@ This file provides helper functions used to normalize the arguments that go into search queries. Mainly converting the strings given by the user into proper data types. ''' - from . import constants from . import exceptions from . import helpers diff --git a/frontends/etiquette_flask/etiquette_flask/caching.py b/frontends/etiquette_flask/etiquette_flask/caching.py index 2696f89..53ea7a9 100644 --- a/frontends/etiquette_flask/etiquette_flask/caching.py +++ b/frontends/etiquette_flask/etiquette_flask/caching.py @@ -3,11 +3,11 @@ import functools import hashlib import time -import etiquette - from voussoirkit import cacheclass from voussoirkit import pathclass +import etiquette + def cached_endpoint(max_age): ''' diff --git a/frontends/etiquette_flask/etiquette_flask/common.py b/frontends/etiquette_flask/etiquette_flask/common.py index c2fb320..67e67d9 100644 --- a/frontends/etiquette_flask/etiquette_flask/common.py +++ b/frontends/etiquette_flask/etiquette_flask/common.py @@ -3,11 +3,11 @@ import os import mimetypes import traceback -import etiquette - from voussoirkit import bytestring from voussoirkit import pathclass +import etiquette + from . import caching from . import jinja_filters from . import jsonify diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/photo_endpoints.py b/frontends/etiquette_flask/etiquette_flask/endpoints/photo_endpoints.py index 34b5824..c455003 100644 --- a/frontends/etiquette_flask/etiquette_flask/endpoints/photo_endpoints.py +++ b/frontends/etiquette_flask/etiquette_flask/endpoints/photo_endpoints.py @@ -3,10 +3,10 @@ import json import traceback import urllib.parse -import etiquette - from voussoirkit import cacheclass +import etiquette + from .. import common from .. import decorators from .. import helpers diff --git a/frontends/etiquette_flask/etiquette_flask/jinja_filters.py b/frontends/etiquette_flask/etiquette_flask/jinja_filters.py index f5e85ad..077075a 100644 --- a/frontends/etiquette_flask/etiquette_flask/jinja_filters.py +++ b/frontends/etiquette_flask/etiquette_flask/jinja_filters.py @@ -1,10 +1,10 @@ import datetime import jinja2.filters -import etiquette - import voussoirkit.bytestring +import etiquette + def bytestring(x): try: diff --git a/frontends/etiquette_flask/etiquette_flask/sessions.py b/frontends/etiquette_flask/etiquette_flask/sessions.py index e4bebb3..e8ab7f0 100644 --- a/frontends/etiquette_flask/etiquette_flask/sessions.py +++ b/frontends/etiquette_flask/etiquette_flask/sessions.py @@ -4,10 +4,10 @@ import math import os import werkzeug.wrappers -import etiquette - from voussoirkit import cacheclass +import etiquette + SESSION_MAX_AGE = 86400 REQUEST_TYPES = (flask.Request, werkzeug.wrappers.Request, werkzeug.local.LocalProxy) diff --git a/frontends/etiquette_flask/etiquette_flask_entrypoint.py b/frontends/etiquette_flask/etiquette_flask_entrypoint.py index a48904f..0f539b9 100644 --- a/frontends/etiquette_flask/etiquette_flask_entrypoint.py +++ b/frontends/etiquette_flask/etiquette_flask_entrypoint.py @@ -5,9 +5,9 @@ If you are using Gunicorn, for example: gunicorn etiquette_flask_entrypoint:site --bind "0.0.0.0:PORT" --access-logfile "-" ''' import sys +import werkzeug.contrib.fixers import etiquette_flask -import werkzeug.contrib.fixers etiquette_flask.site.wsgi_app = werkzeug.contrib.fixers.ProxyFix(etiquette_flask.site.wsgi_app) diff --git a/frontends/etiquette_flask/etiquette_flask_launch.py b/frontends/etiquette_flask/etiquette_flask_launch.py index 69c337b..42c7286 100644 --- a/frontends/etiquette_flask/etiquette_flask_launch.py +++ b/frontends/etiquette_flask/etiquette_flask_launch.py @@ -12,8 +12,8 @@ log_format = '{levelname}:etiquette.{module}.{funcName}: {message}' handler.setFormatter(logging.Formatter(log_format, style='{')) logging.getLogger().addHandler(handler) -import gevent.pywsgi import argparse +import gevent.pywsgi import sys import etiquette_flask_entrypoint diff --git a/frontends/etiquette_flask/static/css/common.css b/frontends/etiquette_flask/static/css/common.css index 0a50afd..818ac04 100644 --- a/frontends/etiquette_flask/static/css/common.css +++ b/frontends/etiquette_flask/static/css/common.css @@ -1,16 +1,3 @@ -/* -Organization: -{ - own grid area name - display, flexing, gridding - positioning and alignment - bounding box (width, margin, overflow, ...) - borders and shadows - backgrounds - foregrounds - misc -} -*/ :root { --color_site_theme: #00d8f4; diff --git a/styleguide.md b/styleguide.md new file mode 100644 index 0000000..77d72a0 --- /dev/null +++ b/styleguide.md @@ -0,0 +1,39 @@ +Etiquette styleguide +==================== + +## Python + +### imports + +```Python +''' +docstring +''' +library imports + +voussoirkit imports + +etiquette imports + +local folder imports + +dot imports + + +# code +``` + +## CSS + +```css +{ + own grid area name + display, flexing, gridding + positioning and alignment + bounding box (width, margin, overflow, ...) + borders and shadows + backgrounds + foregrounds + misc +} +``` \ No newline at end of file