filestorage/README.md

24 lines
642 B
Markdown
Raw Normal View History

2016-11-18 19:08:48 +01:00
# Filestorage
2016-11-18 14:12:55 +01:00
2016-11-18 19:08:48 +01:00
This is a simple file storage and permanent archive service written in python using pyramid.
It allows people to drop off files through a REST API which are then assigned a UUIDv4 to link to.
This allows to easily achieve permanent links to files.
2016-11-18 14:12:55 +01:00
2016-11-18 19:08:48 +01:00
An easy to use web frontend for the api using jQuery is TBD.
##Install dependencies
```
2016-11-18 14:12:55 +01:00
export VENV=/path/to/venv
python3 -m venv $VENV
$VENV/bin/pip install -e .
2016-11-18 19:08:48 +01:00
```
##Run the application
2016-11-18 14:12:55 +01:00
2016-11-18 19:08:48 +01:00
```
2016-11-18 14:12:55 +01:00
$VENV/bin/pserve settings.ini --reload
2016-11-18 19:08:48 +01:00
```
2016-11-18 14:12:55 +01:00
2016-11-18 19:08:48 +01:00
The `--reload` option is optional and helpful for development purposes.
Also, different wsgi servers can be used. (More about that later)