huscy.project-documents 1.4.2

Managing document files for projects.

huscy.project_documents

Requirements

• Python 3.8+
• A supported version of Django

Tox tests on Django versions 4.2, 5.0 and 5.1.

Installation

To install husy.project_documents simply run:

pip install huscy.project_documents

Configuration

We need to hook huscy.project_documents into our project. This package depends on huscy.projects so we have to add this as well. We also have to add further requirements for django_guardian, django_restframework and drf_nested_routers.

1. Add packages into your INSTALLED_APPS at settings module:

INSTALLED_APPS = (
    ...
    'guardian',
    'rest_framework',
    'rest_framework_nested',

    'huscy.project_documents',
    'huscy.projects',
)

2. Create huscy.project_documents database tables by running:

python manage.py migrate

Development

After checking out the repository you should run

make install

to install all development and test requirements and

make migrate

to create the database tables. We assume you have a running postgres database with a user huscy and a database also called huscy. You can easily create them by running

sudo -u postgres createdb huscy
sudo -u postgres createuser -d huscy
sudo -u postgres psql -c "ALTER USER huscy WITH PASSWORD '123'"
sudo -u postgres psql -c "ALTER DATABASE huscy OWNER TO huscy;"