Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update installation instructions #30

Merged
merged 1 commit into from
May 26, 2023
Merged

Update installation instructions #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# cve-py

![python application](https://github.com/Pavel-Sushko/cve-py/actions/workflows/python-app.yml/badge.svg) ![dependency review](https://github.com/Pavel-Sushko/cve-py/actions/workflows/dependency-review.yml/badge.svg)
![pypi version](https://github.com/Pavel-Sushko/cve-py/actions/workflows/python-publish.yml/badge.svg) ![python application](https://github.com/Pavel-Sushko/cve-py/actions/workflows/python-app.yml/badge.svg) ![dependency review](https://github.com/Pavel-Sushko/cve-py/actions/workflows/dependency-review.yml/badge.svg)

cve-py is a Python library that allows users to track Common Vulnerabilities and Exposures (CVEs) from the National Vulnerability Database (NVD). The project fetches data from the NVD and stores it in a database for easy access and analysis.

## Installation

1. Clone the repository: `git clone https://github.com/Pavel-Sushko/cve-py.git`
2. Navigate to the project directory: `cd cve-py`
3. Install the package: `pip install .`
4. Fetch the latest CVE data from the NVD, and store them in the `data/` directory: `python main.py`
1. Install package from PyPI:

```bash
pip install cve-py
```

## Contributing

Expand Down