From bbd7c0e541fcbf2728dfcb36205497caacfb61cc Mon Sep 17 00:00:00 2001 From: Artem Burashnikov Date: Sun, 10 Dec 2023 01:26:22 +0300 Subject: [PATCH] update: readme and project description --- README.md | 24 +++++++++++++++++------- pyproject.toml | 2 +- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 44edff5..ed8a4c6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,17 @@ ## Overview -Depinspect is an utility designed to prodive insights into linux package dependencies across multiple architectures and distributions. +**Depinspect** is an utility that offers an abstraction layer which simplifies the retrieval of package-related information across different distributions and architectures. + +## Features + +- **Data Aggregation:** Gathers information about packages from multiple distributions and their corresponding releases. + +- **Unified Access:** Provides a streamlined and unified access point for stored metadata. + +- **Modular Architecture:** Employs a modular design for simpler extendability, allowing easy integration of new features. + +- **CLI Support:** Includes a Command-Line Interface (CLI) for a quick overview of divergent dependencies and other relevant information. ## Table of contents @@ -66,6 +76,10 @@ Open the terminal and follow these steps: TODO +### `depinspect update` + +TODO + ### `depinspect diff` This command requires two `--package` options to be specified. @@ -76,10 +90,6 @@ TODO TODO -### `depinspect update` - -TODO - ### `depinspect find-divergent` TODO @@ -96,9 +106,9 @@ It is helpful to see the list of available architectures and package names store depinspect list-all ubuntu > ubuntu_available_data.txt ``` -### Initialize or re-initialize the database +### Initialize or update the metadata in databases -The tool ensures that databases exist before you can query for information. You can also manually call this process (for example, in order to update the stored metadata) by running: +The metadata is stored in SQLite databases. You can manually update it by running: ```sh depinspect update diff --git a/pyproject.toml b/pyproject.toml index a5f99fe..14ff0d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] name = "depinspect" version = "0.3.0" -description = "A tool to analyze linux package dependencies across multiple distributions and architectures" +description = "A tool that aggregates metadata from various Linux distributions, offering an abstraction layer which simplifies the retrieval of package-related information." license = "MIT" authors = ["Artem Burashnikov "] maintainers = ["Artem Burashnikov "]