Logo

Contents

  • Using Hermine
    • Installing Hermine
      • Development
      • Docker Compose
      • Manual production install
      • OAuth
      • Health check
    • Getting started
      • Main concepts used
      • Manual workflow
    • Analysing licenses
      • Global characterics
      • Obligations and generic obligations
    • REST API
      • Authentication via Token
      • Uploading a BOM file
      • Checking the validation steps
      • Example
      • JUnit
      • Generic obligations endpoints
      • Generic API endpoints for Models
  • Developing Hermine
    • Coding standards
      • Developer Certificate of Origin
      • REUSE standard
      • Code linting
      • Commit messages
    • The Data Model
      • Models for license management
      • Models for validation rules
      • Models for internal product management
      • Models for 3rd party components
    • Custom tags for Django templates
    • Tests
      • Running the tests
      • Coverage
Hermine
  • »
  • Developing Hermine
  • View page source

Developing Hermine

In the following, we assume you have poetry installed in a version 1.2 or later and that you have installed a local version of Hermine.

We document here the Hermine-specific aspects of the code. The different FOSS components on which Hermine relies have their own, very useful doc:

  • Django documentation

  • Django REST Framework documentation

  • Django filter

  • Pacakge URL (Purl) specification and its Python library

Contents

  • Coding standards
    • Developer Certificate of Origin
    • REUSE standard
    • Code linting
    • Commit messages
  • The Data Model
    • Models for license management
    • Models for validation rules
    • Models for internal product management
    • Models for 3rd party components
  • Custom tags for Django templates
  • Tests
    • Running the tests
    • Coverage
Previous Next

© Copyright 2021, Hermine Team.

Built with Sphinx using a theme provided by Read the Docs.