# Faker-Security
[](https://pypi.org/project/faker-security/)
[](https://circleci.com/gh/snyk/faker-security/tree/main)
Provider for [Faker](https://github.com/joke2k/faker)
to generate random/fake data related to security.
## Requirements
- Faker
- Python 3.8+
## Installation and Usage
If you want to use `faker-security` within your project, add it to your dependency file of choice.
This is typically your project's `requirements.txt` file. If you are using a higher-level package manager like `poetry` or `pipenv`, follow their instructions for adding new packages.
Once installed, you need to setup `Faker` to make use of the `SecurityProvider`. An example of how that could be done is shown below:
```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
- `ccss`: generates a CCSS 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/snyk/faker-security",
"name": "faker-security",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "faker",
"author": "Snyk Security R&D",
"author_email": "security-engineering@snyk.io",
"download_url": "https://files.pythonhosted.org/packages/d7/b7/974636e16923610305be4d0a4c9a29735a799c709baaf0cf2466ddf2c17b/faker_security-0.4.0.tar.gz",
"platform": null,
"description": "# Faker-Security\n\n[](https://pypi.org/project/faker-security/)\n[](https://circleci.com/gh/snyk/faker-security/tree/main)\n\nProvider for [Faker](https://github.com/joke2k/faker)\nto generate random/fake data related to security.\n\n## Requirements\n\n- Faker\n- Python 3.8+\n\n## Installation and Usage\n\nIf you want to use `faker-security` within your project, add it to your dependency file of choice.\n\nThis is typically your project's `requirements.txt` file. If you are using a higher-level package manager like `poetry` or `pipenv`, follow their instructions for adding new packages.\n\nOnce installed, you need to setup `Faker` to make use of the `SecurityProvider`. An example of how that could be done is shown below:\n\n```python\nfrom faker import Faker\nfrom faker_security.providers import SecurityProvider\n\nfake = Faker()\nfake.add_provider(SecurityProvider)\n\n# generate a CVSSv3 vector\nfake.cvss3()\n```\n\n## Provider Features\n\n- `cvss3`: generates a CVSS v3 vector\n- `cvss2`: generates a CVSS v2 vector\n- `ccss`: generates a CCSS vector\n- `version`: generates a [semver version number](https://semver.org/)\n- `npm_semver_range`: generates a [npm compatible semver version range](https://docs.npmjs.com/about-semantic-versioning)\n- `cwe`: generates a CWE identifier\n- `cve`: generates a CVE identifier\n\n## Developing\n\n- Install `poetry` and run `poetry install`\n- Install `pre-commit` and run `pre-commit install --install-hooks`\n\n## Testing\n\n`poetry run pytest` to run tests.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Faker provider for security related data",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/snyk/faker-security",
"Repository": "https://github.com/snyk/faker-security"
},
"split_keywords": [
"faker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15ee59509e46a79819ae927ab526eb03ba4923a237900f4803262d9b4b14d932",
"md5": "80518ff2649ba61d81e72538f1686785",
"sha256": "0919bbdaca5c1f6d42e80d82f2cba54324a5a5b2c0329c71949a39b11ed6673c"
},
"downloads": -1,
"filename": "faker_security-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "80518ff2649ba61d81e72538f1686785",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3966,
"upload_time": "2023-08-17T14:42:50",
"upload_time_iso_8601": "2023-08-17T14:42:50.316621Z",
"url": "https://files.pythonhosted.org/packages/15/ee/59509e46a79819ae927ab526eb03ba4923a237900f4803262d9b4b14d932/faker_security-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7b7974636e16923610305be4d0a4c9a29735a799c709baaf0cf2466ddf2c17b",
"md5": "792b351ed47f3b554bd687812a4c5c76",
"sha256": "6d465dad3a7deda4dbb800040366d794496b63bb2b2a606f63971bdff88bd3df"
},
"downloads": -1,
"filename": "faker_security-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "792b351ed47f3b554bd687812a4c5c76",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3433,
"upload_time": "2023-08-17T14:42:51",
"upload_time_iso_8601": "2023-08-17T14:42:51.692328Z",
"url": "https://files.pythonhosted.org/packages/d7/b7/974636e16923610305be4d0a4c9a29735a799c709baaf0cf2466ddf2c17b/faker_security-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-17 14:42:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "snyk",
"github_project": "faker-security",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "faker-security"
}
JSON
