crunchdao / desci-framework

MIT License
10 stars 0 forks source link

IMAGE ALT TEXT HERE

[![Build status](https://github.com/crunchdao/desci-framework/workflows/build/badge.svg?branch=main&event=push)](https://github.com/crunchdao/desci-framework/actions?query=workflow%3Abuild) [![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/crunchdao/desci-framework/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit) [![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/crunchdao/desci-framework/blob/main/.pre-commit-config.yaml) [![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/crunchdao/desci-framework/releases) [![License](https://img.shields.io/github/license/crunchdao/desci-framework)](https://github.com/crunchdao/desci-framework/blob/main/LICENSE) `desci` is the Python package for Decentralized Science by [CrunchDAO](https://www.crunchdao.com/)

Description

CrunchDAO is a Decentralized Autonomous Organization of scientists making use of collective intelligence to solve complex problems, powered by a tokenomics.

We are here proposing a Decentralized Science Framework, making use of git and IPFS, that enables every group of scientists to collaborate on a single Unit of Knowledge, avoiding the so-called tragedy of anticommons, using the principles of continuous integration/continuous delivery, in a way that also tackles the reproducibility crisis in science.

The use of IPFS enables the integration and recognition of micropublications and the setup of a retroactive funding framework. Moreover, it makes it possible to build around the concept of machine readability, and self describing metadata, as the technology has the capacity to make digital goods immutable, transparent, externally provable, decentralized, and distributed.

Removing the need to write papers using only PDFs, it is possible to integrate multimedia contents, fostering outreach and education.

The latest PDF version of this project, automatically generated with git every time a merge request is validated by CrunchDAO, can be accessed at desci.crunchdao.com. We will soon setup a bounty system for working on the project and a voting system to approve/reject updates of the white paper.

Vision

IMAGE ALT TEXT HERE

Tutorial

IMAGE ALT TEXT HERE

Installation

Makefile contains functions for faster development.

1. Install all dependencies and pre-commit hooks

```bash make install ```

2. Codestyle

Automatic formatting uses `pyupgrade`, `isort`, and `black`. ```bash make codestyle # or use synonym make formatting ``` Codestyle checks only, without rewriting files: ```bash make check-codestyle ``` > Note: `check-codestyle` uses `isort`, `black` and `darglint` library Update all dev libraries to the latest version using one command ```bash make update-dev-deps ```

3. Cleanup

Delete pycache files ```bash make pycache-remove ``` Remove package build ```bash make build-remove ``` Delete .DS_STORE files ```bash make dsstore-remove ``` Remove .mypycache ```bash make mypycache-remove ``` Or to remove all above run: ```bash make cleanup ```

Credits 🚀 Your next Python package needs a bleeding-edge project structure.

This project was generated with python-package-template