Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/acdh-oeaw/fwm

Web-Application for the FWF-Project "Fingerprinting White Marbles"

https://github.com/acdh-oeaw/fwm

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary

Keywords

djangobaseproject
Last synced: 10 months ago · JSON representation

Repository

Web-Application for the FWF-Project "Fingerprinting White Marbles"

Basic Info
  • Host: GitHub
  • Owner: acdh-oeaw
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 7.25 MB
Statistics
  • Stars: 1
  • Watchers: 6
  • Forks: 0
  • Open Issues: 0
  • Releases: 16
Topics
djangobaseproject
Created over 4 years ago · Last pushed about 2 years ago
Metadata Files
Readme License

README.md

Test flake8 Lint codecov Build and push to DockerHub

Fingerprinting White Marbles

Web-Application for the FWF-Project "Fingerprinting White Marbles" (P 33042)

install

  • clone the repo git clone https://github.com/acdh-oeaw/fwm.git
  • change into the project's root directory e.g. cd fwm
  • create a virtual environment e.g. virtualenv env and activate it source env/bin/activate
  • install required packages pip install -r requirements_test.txt
  • run migrations python manage.py migrate
  • start the dev sever python manage.py runserver
  • go to http://127.0.0.1:8000 and check if everything works

DB-config

configuration of database settings (and debug mode) is done via env variables, see djangobaseproject/settings.py which variables can be set

running async tasks

In order to run async task, you'll need to start a celery worker e.g. with * celery -A djangobaseproject worker -l INFO

Docker

At the ACDH-CH we use a centralized database-server. So instead of spawning a database for each service our services are talking to a database on this centralized db-server. This setup is reflected in the dockerized setting as well, meaning it expects an already existing database (either on your host, e.g. accessible via 'localhost' or some remote one)

building the image

  • docker build -t fwm:latest .
  • docker build -t fwm:latest --no-cache .

running the image

To run the image you should provide an .env file to pass in needed environment variables; see example below:

  • docker run -it -p 8020:8020 --env-file env.default --name fwm fwm:latest

This project was bootstraped by djangobase-cookiecutter

Owner

  • Name: Austrian Centre for Digital Humanities & Cultural Heritage
  • Login: acdh-oeaw
  • Kind: organization
  • Email: acdh@oeaw.ac.at
  • Location: Vienna, Austria

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 7
  • Total pull requests: 5
  • Average time to close issues: 2 months
  • Average time to close pull requests: 5 minutes
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.14
  • Average comments per pull request: 0.2
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • csae8092 (7)
Pull Request Authors
  • csae8092 (4)
  • karlburkhart (1)
Top Labels
Issue Labels
houskeeping (3)
Pull Request Labels

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v2 composite
.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • py-actions/flake8 v1 composite
.github/workflows/test.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • codecov/codecov-action v1 composite
  • postgis/postgis 12-master docker
Dockerfile docker
  • python 3.8-buster build
requirements.txt pypi
  • Django >=3.2,<4
  • acdh-django-browsing ==1.1.0
  • acdh-django-netvis >=3.1.0
  • celery ==5.2.1
  • django-celery-results ==2.2.0
  • django-leaflet >=0.28
  • django-mptt >=0.13.4
  • django-spaghetti-and-meatballs ==0.4.2
  • django_extensions >=3.1
  • openpyxl ==3.0.9
  • psycopg2-binary >=2.9.0
  • rdflib >=5.0
  • requests >=2.25
  • tqdm >=4.62
requirements_test.txt pypi
  • coverage >=5.5 test
  • flake8 >=4.0.0 test