soufi 2024.3.4

Description:

soufi 2024.3.4

Soufi (Source Finder) is a library that finds downloadable URLs for
source packages, given the binary package name and version. It will also
create a compressed archive of multiple downloadable files, or save
any existing downloadable archive.

Currently supported finders are:

Debian OS packages
Ubuntu OS packages
Red Hat (UBI) packages
CentOS packages
Alpine packages
Photon OS packages
AlmaLinux OS packages
NPM packages
Python sdists
Golang modules
Java JARs
Ruby Gems



If you want to download Alpine packages, you must have git installed.

Requirements
Soufi is currently tested on Python versions 3.8 through 3.11. It is
known not to work on 3.6.


Quickstart
Install Soufi with pip:
pip install soufi
or, with the command-line tool:
pip install soufi[cli]

Using the command line
soufi python flask 2.0.0
https://files.pythonhosted.org/packages/37/6d/61637b8981e76a9256fade8ce7677e86a6edcd6d4525f459a6b9edbd96a4/Flask-2.0.0.tar.gz

soufi debian zlib1g 1:1.2.11.dfsg-1 -o zlib.tar.xz
zlib_1.2.11.dfsg.orig.tar.gz: https://snapshot.debian.org/file/1b7f6963ccfb7262a6c9d88894d3a30ff2bf2e23
zlib_1.2.11.dfsg-1.dsc: https://snapshot.debian.org/file/f2bea8c346668d301c0c7745f75cf560f2755649
zlib_1.2.11.dfsg-1.debian.tar.xz: https://snapshot.debian.org/file/c3b2bac9b1927fde66b72d4f98e4063ce0b51f34

ls -l zlib.tar.xz
-rw-rw-r-- 1 juledwar juledwar 391740 May 20 15:20 zlib.tar.xz


Using the API
import shutil
import soufi

finder = soufi.finder.factory(
'python', 'flask', '2.0.0', soufi.finder.SourceType.python
)
source = finder.find()
print(source)

finder = soufi.finder.factory(
'debian', 'zlib1g', '1:1.2.11.dfsg-1', soufi.finder.SourceType.os
)
source = finder.find()
print(source)
with source.make_archive() as archive, open('zlib.tar.xz', 'wb') as local:
shutil.filecopyobj(archive, local)



Caching
Soufi uses dogpile.cache to
provide a convenient mechanism for caching requests when doing repeated
lookups. For sources with network-intensive remote discovery (e.g,,
DNF/Yum-based OSes) this is strongly recommended.
For a single-threaded application, an in-memory LRU cache, should be adequate:
import pylru
import soufi

LRU_CACHE = pylru.lrucache(size=1024)
finder = soufi.finder.factory(
'centos', 'cracklib-dicts', '2.9.0-11.el7', soufi.finder.SourceType.os,
cache_backend='dogpile.cache.memory',
cache_args=dict(cache_dict=LRU_CACHE),
)
print(finder.find())
# Re-using the finder will use cached results
print(finder.find('vim-minimal', '7.4.629-8.el7_9'))
More complex applications can use the other backends, e.g., memcached, Redis,
custom backends, etc. See the
dogpile.cache documentation
for details on backend configuration.


Copyright
Soufi is copyright (c) 2021-2023 Cisco Systems, Inc. and its affiliates
All rights reserved.