gfbio-data-collections

GFBio Data Collections

https://github.com/gfbio/gfbio-data-collections

Science Score: 67.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

GFBio Data Collections

Basic Info
  • Host: GitHub
  • Owner: gfbio
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 2.35 MB
Statistics
  • Stars: 1
  • Watchers: 12
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License Citation Zenodo

README.md

GFBio Data Collection Service

DOI

Description

Collection service is provided by GFBio e.V. and is a central data hub to store and retrieve json for communication and synchronization of user data between different services.

It provides a Rest API for the backends of the connecting Servers to store or retrieve json-data. Each server gets its own secret key for secure retrieval/upload. Therefore the API is required to be accessed from the backends of the using servers.

Developer Guide

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

  • To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

  • To create a superuser account, use this command:

    $ python manage.py createsuperuser
    

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html
Running tests with pytest
$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Celery

This app comes with Celery.

To run a celery worker:

bash cd collection_service celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation.

Contact Us

Please email any questions and comments to our Service Helpdesk (info@gfbio.org).

Acknowledgements

  • This work was supported by the German Research Foundation (DFG) within the project “Establishment of the National Research Data Infrastructure (NFDI)” in the consortium NFDI4Biodiversity (project number 442032008).

Owner

  • Name: GFBio
  • Login: gfbio
  • Kind: organization
  • Location: Germany

German Federation for Biological Data

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Franz"
  given-names: "Linus"
  orcid: "https://orcid.org/0009-0007-0441-8630"
- family-names: "Kostadinov"
  given-names: "Ivaylo"
  orcid: "https://orcid.org/0000-0003-4476-6764"
- family-names: "Weber"
  given-names: "Marc"
  orcid: "https://orcid.org/0000-0003-0694-5817"
title: "GFBio Data Collections"
abstract: "Central data hub to store and retrieve json for communication and synchronization of user data between different services."
type: software
doi: 10.5281/zenodo.8316119
keywords:
  - Data Hub
  - Biodiversity
  - Ecology
  - GFBio
license: MIT

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Dependencies

compose/local/django/Dockerfile docker
  • python ${PYTHON_VERSION} build
  • python latest build
compose/local/docs/Dockerfile docker
  • python ${PYTHON_VERSION} build
  • python latest build
compose/production/django/Dockerfile docker
  • python ${PYTHON_VERSION} build
  • python latest build
compose/production/postgres/Dockerfile docker
  • postgres 14 build
compose/production/traefik/Dockerfile docker
  • traefik v2.2.11 build
requirements/base.txt pypi
requirements/local.txt pypi
requirements/production.txt pypi