Metadata-Version: 2.1
Name: faker-security
Version: 0.1.0
Summary: Faker provider for security related data
Home-page: https://github.com/snyk/faker-security
License: Apache-2.0
Keywords: faker
Author: Snyk Security R&D
Author-email: security-engineering@snyk.io
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: faker (>=8.2.1)
Project-URL: Repository, https://github.com/snyk/faker-security
Description-Content-Type: text/markdown

# Faker-Security

Provider for [Faker](https://github.com/joke2k/faker)
to generate random/fake data related to security.

## Requirements

- Faker
- Python 3.9+

## Installation and Usage

- Add `faker-security` to your requirements
- Install `faker-security` using `pip` or whatever package manager you use
- Add the `SecurityProvider` during tests or wherever you use Faker

```python
from faker import Faker
from faker_security.providers import SecurityProvider

fake = Faker()
fake.add_provider(SecurityProvider)

# generate a CVSSv3 vector
fake.cvss3()
```

## Provider Features

- `cvss3`: generates a CVSS v3 vector
- `cvss2`: generates a CVSS v2 vector
- `version`: generates a [semver version number](https://semver.org/)
- `npm_semver_range`: generates a [npm compatible semver version range](https://docs.npmjs.com/about-semantic-versioning)
- `cwe`: generates a CWE identifier
- `cve`: generates a CVE identifier

## Developing

- Install `poetry` and run `poetry install`
- Install `pre-commit` and run `pre-commit install --install-hooks`

## Testing

`poetry run pytest` to run tests.

