FOSSLight Util

FOSSLight Util is released under the Apache-2.0. Current python package version. REUSE status

It is a package that supports common utils used by FOSSLight Scanner.

Features

  1. It simplifies the logger setup.
  2. It provides a simple function to create a output file.
  3. It provides a spdx license list with json format.
  4. It defines common constant variables.
  5. It provides a thread that prints the spinner.
  6. Download source code.

Contents

📋 Prerequisite

FOSSLight Util needs a Python 3.10+.

🎉 How to install

It can be installed using pip3.

$ pip3 install fosslight_util

🚀 How to use

Three modules can be called. Please refer to each file for detailed calling method.

1. Setup logger (tests/test_log.py)

from fosslight_util.set_log import init_log

# 1st param : log file path
# 2nd param : create file (True/False)
# 3rd param : stream log level
# 4th param : file log level
#            =>log level(CRITICAL:50, ERROR:40, WARNING:30, INFO:20, DEBUG:10, NOTSET:0)
# 5th param : package name of fosslight scanners (fosslight_source / fosslight_dependency / fosslight_reuse)
# 6th param : path to analyze
#
# 1st return value : a logger
# 2nd return value : log items to print

def test():
    logger, log_item = init_log("test_result/log_file1.txt", True, 30, 20)
    logger.warning("TESTING - Print log")

2. Write result files (tests/test_output_format.py)

from fosslight_util.output_format import write_output_file

# 2nd param : output file format
#            => file format(excel: .xlsx, csv: .csv, opossum: .json)
def test():
    sheet_contents = {'SRC':[['run_scancode.py', 'fosslight_source',
                        '3.0.6', 'Apache-2.0',  'https://github.com/LGE-OSS/fosslight_source', 'https://github.com/LGE-OSS/fosslight_source', 'Copyright (c) 2021 LG Electronics, Inc.', 'Exclude', 'Comment message'],
                       ['dependency_unified.py', 'fosslight_dependency',
                        '3.0.6', 'Apache-2.0',  'https://github.com/LGE-OSS/fosslight_dependency', 'https://github.com/LGE-OSS/fosslight_dependency', 'Copyright (c) 2020 LG Electronics, Inc.', '', '']],
                      'BIN':[['askalono.exe', 'askalono',
                        '0.4.3', 'Apache-2.0', 'https://github.com/jpeddicord/askalono', '', 'Copyright (c) 2018 Amazon.com, Inc. or its affiliates.', '', '']]}
    success, msg = write_output_file('test_result/excel/FOSSLight-Report', '.xlsx', sheet_contents)

3. Get spdx licenses (tests/test_spdx_licenses.py)

from fosslight_util.spdx_licenses import get_spdx_licenses_json


def test():
    success, error_msg, licenses = get_spdx_licenses_json()

4. Load common constant (tests/_print_log_with_another_logger.py)

import fosslight_util.constant as constant


logger = logging.getLogger(constant.LOGGER_NAME)
logger.warning("Get a logger after init_log is called once.")

5. Call a spinner (tests/test_timer.py)

from fosslight_util.timer_thread import TimerThread


timer = TimerThread()
timer.setDaemon(True)
timer.start()

6. Download the source code (tests/test_download.py)

If you give a link, the source is downloaded to the target directory through git clone or wget.

How it works

  1. Try git clone. 1-1. If the link is ssh-url, convert to https-url.
  2. If git clone fails, download it with wget and extract the compressed file.
  3. After extracting the compressed file, delete the compressed file.

Parameters

Parameter Argument Description
h None Print help message.
s String Link to download.
t String Path to download and extract.
d String Path to save a log file.

How to run

$ fosslight_download -s "https://github.com/LGE-OSS/example" -t target_dir/

Limit download size (GB) with --size-limit / -l (omit for unlimited):

$ fosslight_download -s "https://github.com/LGE-OSS/example" -t target_dir/ -l 5

If you want to try with private repository, set your github token like below.

$ fosslight_download -s "https://my_github_token@github.com/Foo/private_repo -t target_dir/"

📝 How to report issue

Please report any ideas or bugs to improve by creating an issue in fosslight_util repository. Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.

👏 Contributing Guide

We always welcome your contributions. Please see the CONTRIBUTING guide for how to contribute.

📄 License

FOSSLight Util is released under Apache-2.0.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.2.13)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for LGE-OSS from gravatar.com LGE-OSS Avatar for soimsoim from gravatar.com soimsoim

Credits

Author: LG Electronics

License expression

Apache-2.0
View SPDX License List

Requires

Python <3.15, >=3.10

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fosslight_util-2.2.12.tar.gz (965.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fosslight_util-2.2.12-py3-none-any.whl (971.1 kB view details)

Uploaded Python 3

File details

Details for the file fosslight_util-2.2.12.tar.gz.

File metadata

  • Download URL: fosslight_util-2.2.12.tar.gz
  • Upload date:
  • Size: 965.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.14

File hashes

Hashes for fosslight_util-2.2.12.tar.gz
Algorithm Hash digest
SHA256 7459527f4b0d0e944b3d78d7986471f14ac0aff30eea803eeb830130f0eba9f5
MD5 679c2d668d47c44d66d0bfac1d45ba2d
BLAKE2b-256 7834b75f250700930d94fb49e63bdb0e60b0e5632a696a2e795ea3c66f7972d3

See more details on using hashes here.

File details

Details for the file fosslight_util-2.2.12-py3-none-any.whl.

File metadata

File hashes

Hashes for fosslight_util-2.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 63a609b812bbfce8454d41b6389626e492407cef2baa0ff9c5cf375a8d25878c
MD5 918c8de98a10e99d30fe89e146678acf
BLAKE2b-256 538b08fbb849f0bbfb48e7041bf62ae78389961ab3e1a4df436c0e0575b7cc62

See more details on using hashes here.

Release history Release notifications | RSS feed

2.2.13

2 files

This release

2.2.12 This release

2 files

2.2.11

2 files

2.2.10

2 files

2.2.9

2 files

2.2.8

2 files

2.2.7

2 files

2.2.6

2 files

2.2.5

2 files

2.2.4

2 files

2.2.3

2 files

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.64

2 files

2.1.63

2 files

2.1.62

2 files

2.1.61

2 files

2.1.60

2 files

2.1.59

2 files

2.1.58

2 files

2.1.57

2 files

2.1.56

2 files

2.1.55

2 files

2.1.54

2 files

2.1.53

2 files

2.1.52

2 files

2.1.51

2 files

2.1.50

2 files

2.1.49

2 files

2.1.48

2 files

2.1.47

2 files

2.1.46

2 files

2.1.45

2 files

2.1.44

2 files

2.1.43

2 files

2.1.42

2 files

2.1.41

2 files

2.1.40

2 files

2.1.39

2 files

2.1.38

2 files

2.1.37

2 files

2.1.36

2 files

2.1.35

2 files

2.1.34

2 files

2.1.33

2 files

2.1.32

2 files

2.1.31

2 files

2.1.30

2 files

2.1.29

2 files

2.1.28

2 files

2.1.27

2 files

2.1.26

2 files

2.1.25

2 files

2.1.24

2 files

2.1.23

2 files

2.1.22

2 files

2.1.21

2 files

2.1.20

2 files

2.1.19

2 files

2.1.18

2 files

2.1.17

2 files

2.1.16

2 files

2.1.15

2 files

2.1.14

2 files

2.1.13

2 files

2.1.12

2 files

2.1.11

2 files

2.1.10

2 files

2.1.9

2 files

2.1.8

2 files

2.1.7

2 files

2.1.6

2 files

Yanked

2.1.5

2 files

Yanked

2.1.4

2 files

Yanked

2.1.3

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

Yanked

2.0.2

2 files

Yanked

2.0.1

2 files

2.0.0

2 files

1.4.48

2 files

1.4.47

2 files

1.4.46

2 files

1.4.45

2 files

1.4.44

2 files

1.4.43

2 files

1.4.42

2 files

1.4.41

2 files

1.4.40

2 files

1.4.39

2 files

1.4.38

2 files

1.4.37

2 files

1.4.36

2 files

1.4.35

2 files

1.4.34

2 files

1.4.33

2 files

1.4.32

2 files

1.4.31

2 files

1.4.30

2 files

1.4.29

2 files

1.4.28

2 files

1.4.27

2 files

1.4.26

2 files

1.4.25

2 files

1.4.24

2 files

1.4.23

2 files

1.4.22

2 files

1.4.21

2 files

1.4.20

2 files

1.4.19

2 files

1.4.18

2 files

1.4.17

2 files

1.4.16

2 files

1.4.15

2 files

1.4.14

2 files

1.4.13

2 files

1.4.12

2 files

1.4.11

2 files

1.4.10

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.20

2 files

1.3.19

2 files

1.3.18

2 files

1.3.17

2 files

1.3.16

2 files

1.3.15

2 files

1.3.14

2 files

1.3.13

2 files

1.3.12

2 files

1.3.11

2 files

1.3.10

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page