Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add RO-Crate OpenAPI specs #25

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/checks.yaml
uniqueg marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: crate_db checks

on: [push, pull_request]

jobs:
lint-and-test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: "3.10"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install poetry
poetry install

- name: Lint with flake8
run: |
pip install flake8
flake8 crate_db tests

- name: Run tests
run: |
poetry run pytest
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ var/
wheels/
share/python-wheels/
*.egg-info/
*.modified.yaml
.installed.cfg
*.egg
MANIFEST
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ELIXIR Crate DB

[![License][badge-license]][badge-url-license]
[![Docs][badge-docs]][badge-url-docs]
[![Build_status][badge-build-status]][badge-url-build-status]
[![Coverage][badge-coverage]][badge-url-coverage]

## Description

Various research artifacts are produced daily around the world, but managing
them is a tedious task for a researcher as any researcher will want to spend
more time researching new stuff rather than finding a way to efficiently store,
retrieve, or share them. The management of these research artifacts becomes a
problem, that's where exactly Crate DB comes into play.

Crate DB mainly focuses on developing a versatile backend to
manage and share RO_Crates using various technologies. The end goal is to
make it easy for a user to manage any RO_Crate.
1 change: 1 addition & 0 deletions crate_db/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Crate DB root package"""
Empty file added crate_db/api/__init__.py
Empty file.
Loading
Loading