fossology 0.0.5

A library to automate Fossology from Python scripts

A simple wrapper for the Fossology REST API.

See the OpenAPI specification used to implement this library.

Usage

Installation

• Install fossology and required dependencies:

  pip install fossology requests
  

Using the API

• Get a REST API token either from the Fossology server under “User->Edit user account” or generate a token using the method available in this library:

  from fossology import fossology_token
  from fossology.obj import TokenScope
  
  FOSSOLOGY_SERVER = "https://fossology.example.com/"
  FOSSOLOGY_USER = "fossy"
  FOSSOLOGY_PASSWORD = "fossy"
  TOKEN_NAME = "fossy_token"
  
  token = fossology_token(
        FOSSOLOGY_SERVER,
        FOSSOLOGY_USER,
        FOSSOLOGY_PASSWORD,
        TOKEN_NAME,
        TokenScope.WRITE
  )
  

• Start using the API:

  from fossology import Fossology
  
  foss = Fossology(
        FOSSOLOGY_SERVER,
        token,
        FOSSOLOGY_USER
  )
  

Contribute

Develop

• All contributions in form of bug reports, feature requests or merge requests!
• Use proper docstrings to document functions and classes
• Don’t forget to extend the minimal testsuite with the new functions/classes
• The documentation website can automatically be generated by the Sphinx autodoc extension

Build

• You can build the PyPi package using poetry:

  poetry build
  

• Build documentation:

  poetry run sphinx-build docs/source docs/build
  

• Cleanup builds:

  rm -r dist/ build/ docs/build/
  

Test

The testsuite available in this project expects a running Fossology instance under the hostname fossology with the default admin user “fossy”.

Use the latest Fossology container from Docker hub.

• Start the complete test suite or a specific test case:

  poetry run python fossology/tests/tests.py
  poetry run python fossology/tests/test_uploads.py