Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.05 KB

Contributing to Our Project

We're excited that you're interested in contributing to our project! This document outlines the guidelines for contributing to our codebase. We follow the Google Python Style Guide to maintain consistency and readability across our project.

Code Style We adhere to the Google Python Style Guide.

Introduction

ADIT-RADIS-Shared is the shared library for the ADIT and RADIS project. It contains the following features:

  • Password based authentication
  • Token authentication for API access
  • Common code small code utitilities

It also contains a Django example project to play around with the features.

Getting Started

git clone https://github.com/openradx/adit-radis-shared.git
cd adit-radis-shared
poetry install
poetry shell
invoke compose-up

The development server of the example project will be started on http://localhost:8000

If a library dependency is changed, the containers need to be rebuilt (e.g. by running invoke compose-down && invoke compose-up).