| Name | osv-utils JSON |
| Version |
0.3.8
JSON |
| download |
| home_page | None |
| Summary | A package for parsing, representing, and filtering OSV data. |
| upload_time | 2024-10-15 23:06:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
package
osv
utils
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# osv-utils
`osv-utils` is a Python package designed for collecting and loading OSV (Open Source Vulnerability) records from
various ecosystems. It provides an easy-to-use interface to interact with OSV data.
## Installation
To install the `osv-utils` package, you can use pip:
```sh
pip install osv-utils
```
## Setup
Before using `osv-utils`, you may want to configure the data path where OSV records will be stored. By default, the data
will be saved in the `~/.osvutils/gs` directory.
You can customize the `data_path` by providing it during the initialization of `OSVDataCollector` or `OSVDataLoader`.
## Usage
### Collecting OSV Records
To collect OSV records from specific ecosystems, use the `OSVDataCollector` class. Below is an example of how to collect
records from the `GIT` ecosystem:
```python
from osvutils.core.collector import OSVDataCollector
collector = OSVDataCollector(verbose=True)
count = collector(['GIT'])
print(f"Total records collected: {count}")
```
### Loading OSV Records
To load the collected OSV records, use the `OSVDataLoader` class. Below is an example of how to load records from
the `GIT` ecosystem:
```python
from osvutils.core.loader import OSVDataLoader
loader = OSVDataLoader(verbose=True)
loader(['GIT'])
print(len(loader))
```
### Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue for any improvements, bug fixes,
or feature requests.
Raw data
{
"_id": null,
"home_page": null,
"name": "osv-utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "package, osv, utils",
"author": null,
"author_email": "Eduard Pinconschi <eduard.pinconschi@tecnico.ulisboa.pt>",
"download_url": "https://files.pythonhosted.org/packages/51/93/211c2641d2cd78f9112ed7d2064217ee29f88e28da45aec2e738f72823c0/osv_utils-0.3.8.tar.gz",
"platform": null,
"description": "# osv-utils\n\n`osv-utils` is a Python package designed for collecting and loading OSV (Open Source Vulnerability) records from \nvarious ecosystems. It provides an easy-to-use interface to interact with OSV data.\n\n## Installation\n\nTo install the `osv-utils` package, you can use pip:\n\n```sh\npip install osv-utils\n```\n\n## Setup\nBefore using `osv-utils`, you may want to configure the data path where OSV records will be stored. By default, the data \nwill be saved in the `~/.osvutils/gs` directory.\n\nYou can customize the `data_path` by providing it during the initialization of `OSVDataCollector` or `OSVDataLoader`.\n\n## Usage\n\n### Collecting OSV Records\nTo collect OSV records from specific ecosystems, use the `OSVDataCollector` class. Below is an example of how to collect \nrecords from the `GIT` ecosystem:\n\n```python\nfrom osvutils.core.collector import OSVDataCollector\n\ncollector = OSVDataCollector(verbose=True)\ncount = collector(['GIT'])\n\nprint(f\"Total records collected: {count}\")\n```\n\n### Loading OSV Records\n\nTo load the collected OSV records, use the `OSVDataLoader` class. Below is an example of how to load records from \nthe `GIT` ecosystem:\n \n```python\nfrom osvutils.core.loader import OSVDataLoader\n\nloader = OSVDataLoader(verbose=True)\nloader(['GIT'])\nprint(len(loader))\n```\n\n### Contributing\nContributions are welcome! Please feel free to submit a pull request or open an issue for any improvements, bug fixes, \nor feature requests.\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for parsing, representing, and filtering OSV data.",
"version": "0.3.8",
"project_urls": {
"homepage": "https://github.com/epicosy/osvutils",
"repository": "https://github.com/epicosy/osvutils"
},
"split_keywords": [
"package",
" osv",
" utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7a800d1f8ab997cd91468c00ba4b52b69ae0e9b8350cca1fcf1bd9b09b9ee7c",
"md5": "b37b85eeced9c4fd55b88602949059fe",
"sha256": "a7e4af417fe0b6068a1336b488a5063a20be53655e2914c142a40c4301ab9caf"
},
"downloads": -1,
"filename": "osv_utils-0.3.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b37b85eeced9c4fd55b88602949059fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18698,
"upload_time": "2024-10-15T23:06:46",
"upload_time_iso_8601": "2024-10-15T23:06:46.089472Z",
"url": "https://files.pythonhosted.org/packages/d7/a8/00d1f8ab997cd91468c00ba4b52b69ae0e9b8350cca1fcf1bd9b09b9ee7c/osv_utils-0.3.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5193211c2641d2cd78f9112ed7d2064217ee29f88e28da45aec2e738f72823c0",
"md5": "a4db03ff9b6f5af131ff0d99ba5903bb",
"sha256": "e556e9622e71450decaa01cb75da5116b416d21669b7aec65c7915ee13398488"
},
"downloads": -1,
"filename": "osv_utils-0.3.8.tar.gz",
"has_sig": false,
"md5_digest": "a4db03ff9b6f5af131ff0d99ba5903bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14119,
"upload_time": "2024-10-15T23:06:48",
"upload_time_iso_8601": "2024-10-15T23:06:48.186940Z",
"url": "https://files.pythonhosted.org/packages/51/93/211c2641d2cd78f9112ed7d2064217ee29f88e28da45aec2e738f72823c0/osv_utils-0.3.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 23:06:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "epicosy",
"github_project": "osvutils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "osv-utils"
}
