Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mattvonrocketstein/corkscrew

another layer on top of flask (milli-framework?) it supports settings files, basic authentication, and object oriented views
https://github.com/mattvonrocketstein/corkscrew

Last synced: 3 months ago
JSON representation

another layer on top of flask (milli-framework?) it supports settings files, basic authentication, and object oriented views

Awesome Lists containing this project

README

        

[About](#about) |
[Installation](#installation) |
[Configuration](#configuration) |
[CLI](#cli) |
[Testing](#testing) |

About
=========================

I'll write something here one day.

Installation
=======================================

Stable stuff:

```shell
$ pip install corkscrew
```

Freshest stuff:

```shell
$ git clone https://github.com/mattvonrocketstein/corkscrew.git
$ python setup.py develop
```

Sample .ini
==================================

```ini
[mongo]
host=localhost
db_name=some_db_name

[proxy]
/keys=https://github.com/your_username/keys

[redirects]
/gmail=https://gmail.com
/github=/code

[github]
user=your_username

[flask]
app=your.flask.app
host=0.0.0.0
port=5000
debug=false
after_request=corkscrew.plumbing.after_request
before_request=corkscrew.plumbing.before_request
secret_key=random_string
autoindex={'/url/path' : '~/filesystem/path'}

[corkscrew]
views=your.flask.app.views.__views__
default_auth_next=/
templates=corkscrew,your.flask.app
runner=corkscrew.runner.flask
logfile=~/corkscrew.log

[users]
admin=pbkdf2:sha1:hash
```

Command Line
==================================
```shell
>corkscrew -h
usage: corkscrew [-h] [-c CMD] [-e EXECFILE] [-v] [--shell]
[--config CONFIG] [--port PORT]
[--runner RUNNER] [--encode ENCODE]

optional arguments:
-h, --help show this help message and exit
-c CMD just like python -c or sh -c (pass in a command)
-e EXECFILE, --exec EXECFILE
a filename to execute
-v, --version show version information
--shell application shell
--config CONFIG use config file
--port PORT server listen port
--runner RUNNER dotpath for app server
--encode ENCODE encode password hash using werkzeug
```

Jinja Filters
=========================================

* intcomma (humanize.intcomma)
* nautraltime (humanize.naturaltime)
* nautraldate (humanize.naturaldate)

CSS / Javascript
=============================================

TESTING
=============================

```shell
$ cd corkscrew
$ tox
```