huscy.projects 1.12.0

Managing projects in a research context.

huscy.projects

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.projects simply run:

pip install huscy.projects

Add huscy.projects and further required apps to INSTALLED_APPS in your settings module:

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

	'huscy.projects',
)

Add Django Guardian ObjectPermissionBackend to AUTHENTICATION_BACKENDS

AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend',
    'guardian.backends.ObjectPermissionBackend',
)

Hook the urls from huscy.projects into your urls.py:

urlpatterns = [
    ...
	path('/api/', include('huscy.projects.urls')),
]

Create huscy.projects database tables by running:

python manage.py migrate

Development

Install PostgreSQL and create a database user called huscy and a database called huscy.

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

Checking out the repository start your virtual environment (if necessary).

Install all development and test dependencies:

make install

Create Database tables:

make migrate

Run tests to see if everything works fine:

make test