flaskup 0.1.1

Overview

Flaskup! is a simple Flask application to share files with your friends. You upload files through an HTML form, and you get back a link to download the file. You can do whatever you want with the link (copy it in an email or in your prefered chat app, it’s up to you).

Requirements

• Python 2.6 (may work with other versions but not tested, feedbacks are welcome)

• Flask >= 0.8

• Flask-Babel >= 0.8

• Flask-Mail >= 0.6.1

• simplejson

Installation

• Install Flaskup! with setup.py (I recommend you to use virtualenv):

  python setup.py install

• Use your favorite WSGI server to run Flaskup! (the WSGI application is flaskup:app). For example, to use Flaskup! with Gunicorn:

  gunicorn --bind=127.0.0.1:8001 flaskup:app

• Alternatively, you can start Flaskup! with the builtin Flask webserver (for testing or developpement only).

  create a file run-server.py:

  from flaskup import app
  app.run()

  run it:

  python run-server.py

Configuration

You MUST set the environment variable FLASKUP_CONFIG that point to a valid python file. In this file you will be able to customize the configuration for Flaskup!, Flask and the Flask extensions.

# -*- coding: utf-8 -*-

DEBUG = True
FLASKUP_UPLOAD_FOLDER = '/srv/flaskup/data'
FLASKUP_MAX_DAYS = 10
FLASKUP_KEY_LENGTH = 4
DEFAULT_MAIL_SENDER = 'flaskup@example.com'
FLASKUP_ADMINS = ['admin@example.com', 'admin@example.org']

Delete expired files

Flaskup! comes with the command line tool flaskup. This tool is a generic python script to call actions. Currently the only available action is clean.

$ . /path/to/env/bin/activate
$ export FLASKUP_CONFIG=/path/to/my/flaskup_config.py
$ flaskup clean

TODO

• fix my engrish

• custom error pages

Credits

Flaskup! is maintained by Laurent Meunier.

Licenses

Flaskup! is Copyright (c) 2012 Laurent Meunier. It is free software, and may be redistributed under the terms specified in the LICENSE file (a 3-clause BSD License).

Flaskup! uses Bootstrap (Apache License v2.0) and jQuery (MIT or GPLv2 License).