1"""
 2## Introduction
 3Olivia Finder is an open source tool that can be used to extract data from software package dependency networks in package managers. 
 4
 5It is designed to work in conjunction with Olivia, and uses web-scraping techniques and CSV files as data sources. With Olivia Finder, you can easily extract information on package dependencies, versions, and other relevant data. This information can be used to analyze software packages and their dependencies, identify potential vulnerabilities or issues, and make informed decisions about which packages to use or avoid. Additionally, Olivia Finder is highly customizable and extensible, allowing you to tailor it to your specific needs and requirements.
 6
 7## Olivia Finder datasets
 8
 9The data obtainded using olivia finder has been published on Zenodo
10
11[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8095863.svg)](https://doi.org/10.5281/zenodo.8095863)
12
13All data at Kaggle
14
15[![Olivia Finder Results](https://img.shields.io/badge/Kaggle-All%20Data%20-%23ffff)](https://www.kaggle.com/datasets/danielalonsob/dependency-networks)
16
17
18
19## Doc pages
20Olivia Finder's documentation is found in Github Pages. 
21
22The documentation includes details about the functionalities implemented in the library, as well as instructions on how to install the previous requirements and configure a virtual environment for use.
23
24[![Olivia-Finder doc](https://img.shields.io/badge/DOC-Olivia--Finder-blue)](https://dab0012.github.io/olivia-finder)
25
26
27## Quality metrics
28<!---
29[![Codacy Badge](https://app.codacy.com/project/badge/Grade/771e39014ceb48688cb9d341c705ecf9)](https://www.codacy.com/gh/dab0012/olivia-finder/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=dab0012/olivia-finder&amp;utm_campaign=Badge_Grade)
30-->
31[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=dab0012_olivia&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=dab0012_olivia)
32[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dab0012_olivia&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dab0012_olivia)
33[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=dab0012_olivia&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=dab0012_olivia)
34[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=dab0012_olivia&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=dab0012_olivia)
35[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=dab0012_olivia&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=dab0012_olivia)
36[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=dab0012_olivia&metric=bugs)](https://sonarcloud.io/summary/new_code?id=dab0012_olivia)
37[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=dab0012_olivia&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=dab0012_olivia)
38
39## Intended audience
40
41Olivia Finder is destined to be used by developers, researchers and centralized packages interested in the identification and analysis of vulnerabilities. It is designed to be used jointly with Olivia, suggesting that users must be familiar with this related tool. In general, users are expected to have technical knowledge and experience in handling networks of software packages.
42
43## Olivia Finder Notebooks
44Run olivia-finder notebooks in Deepnote cloud 
45<br> 
46
47|  Implementation | Data manipulation | Usage | Bowtie Metrics |Github Example  | 
48|---|---|---|---|---|
49| [![Olivia Finder - Implementation](https://img.shields.io/badge/Kaggle-Implementation%20-%23ffff)](https://www.kaggle.com/code/danielalonsob/olivia-finder-implementation-details) | [![Data Manipulation](https://img.shields.io/badge/Kaggle-Data%20Manipulation%20-%23ffff)](https://www.kaggle.com/danielalonsob/olivia-finder-data-manipulation) | [![Usage](https://img.shields.io/badge/Github-Usage-purple)](https://github.com/dab0012/olivia-finder/blob/master/notebooks/olivia_finder/Olivia%20Finder%20-%20Usage.ipynb) | [![Static analysis (Bow-tie)](https://img.shields.io/badge/Kaggle-Bowtie%20Metrics%20-%23ffff)](https://www.kaggle.com/code/danielalonsob/bowtie-network-analisys) | [![Github example](https://img.shields.io/badge/Kaggle-Github%20Example%20-%23ffff)](https://www.kaggle.com/code/danielalonsob/olivia-finder-github-example)
50
51## Olivia Notebooks (Previous TFG)
52
53| Model | Analisis | Immunization |  Repository |
54|---|---|---|---|
55|[![Olivia - Model](https://img.shields.io/badge/Jupyter-Olivia%20--%20Model-%23fa0297)](https://github.com/dsr0018/olivia/blob/master/A-Model.ipynb) | [![Olivia - Analysis](https://img.shields.io/badge/Jupyter-Olivia%20--%20Analysis-%23fa0297)](https://github.com/dsr0018/olivia/blob/master/B-Analysis.ipynb)  |  [![Olivia - Imunization](https://img.shields.io/badge/Jupyter-Olivia%20--%20Imunization-%23fa0297)](https://github.com/dsr0018/olivia/blob/master/C-Immunization.ipynb) |  [![https://github.com/dsr0018/olivia](https://img.shields.io/badge/Github-Olivia-purple)](https://github.com/dsr0018/olivia) |
56 
57
58**Acknowledgements**
59
60Olivia Finder uses data from the Olivia project, which was created by @dsr0018
61
62The Olivia project is distributed under the MIT License.
63
64 
65## License
66
67Olivia Finder is distributed under the MIT License. 
68
69See [LICENSE](https://github.com/dab0012/olivia-finder/blob/06fb2d32146134e833df36bbf9828d4a9c72dc30/LICENSE) file for details.
70
71
72# **Author:** 
73
74**Daniel Alonso Báscones**, (dab0012\<at>alu.ubu.es)
75
76**Carlos López Nozal**, (clopezno\<at>ubu.es)
77
78University of Burgos, 2023
79
80
81
82
83
84"""