Simple Document Management System and Inventory.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

1.0 KiB

OfficeHelper
======

Simple Document Management System and Inventory.

.. _tutorial: http://flask.pocoo.org/docs/tutorial/


Install
-------

Install dependencies::

$ apt install python3-venv python3-flask python3-flask-login python3-flask-sqlalchemy

Get officehelper::

# clone the repository
$ git clone https://dev.xd0.de/hendrik/officehelper
$ cd officehelper

Create a virtualenv and activate it::

$ python3 -m venv --system-site-packages venv
$ . venv/bin/activate

Install Flaskr::

$ pip install -e .

Or if you are using the master branch, install Flask from source before
installing Flaskr::

$ pip install -e ../..
$ pip install -e .


Run
---

::

$ export FLASK_APP=officehelper
$ export FLASK_ENV=development
$ flask init-db
$ flask run

Open http://127.0.0.1:5000 in a browser.


Test
----

::

$ pip install '.[test]'
$ pytest

Run with coverage report::

$ coverage run -m pytest
$ coverage report
$ coverage html # open htmlcov/index.html in a browser