| Name | cems-nuclei JSON |
| Version |
0.5.5
JSON |
| download |
| home_page | |
| Summary | Python wrapper around NUCLEI's functionality. |
| upload_time | 2024-01-17 14:49:15 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 CEMS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# NUCLEI
[](http://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
This repository is created by [CEMS BV](https://cemsbv.nl/) and helps the user to access and process API calls to
the [NUCLEI](https://nuclei.cemsbv.io/#/) environment.
# Installation
To install this package, including the `NucleiClient` library and its dependencies, run:
```bash
pip install cems-nuclei[client]
```
To skip the installation of the `NucleiClient` library, in case you do not need it (e.g. only use pure requests), run:
```bash
pip install cems-nuclei
```
## ENV VARS
To use `nuclei` add the follow ENV vars to your environment. Or provide them when asked.
```
* NUCLEI_TOKEN
- Your NUCLEI user token
```
You can obtain your `NUCLEI_TOKEN` on [NUCLEI](https://nuclei.cemsbv.io/#/).
Go to `personal-access-tokens` and create a new user token.
# Contribution
## Environment
We recommend developing in Python3.9 with a clean virtual environment (using `virtualenv` or `conda`), installing the
requirements from the requirements.txt file:
Example using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:
```bash
python -m venv .env
source activate .env/bin/activate
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .
```
## Documentation
Build the docs:
```bash
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install .
sphinx-build -b html docs public
```
Note: You'll need to set the `NUCLEI_TOKEN` environmental variable.
You can get your token at: `https://cemsbv.crux-nuclei.com`
## Format
We format our code with black and isort.
```bash
black --config "pyproject.toml" src/nuclei tests
isort --settings-path "pyproject.toml" src/nuclei tests
```
## Lint
To maintain code quality we use the GitHub super-linter.
To run the linters locally, run the `run_super_linters.sh` bash script from the root directory.
## UnitTest
Test the software with the use of coverage:
```bash
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install .
coverage run -m pytest
```
## Requirements
Requirements are autogenerated by `pip-compile` with python 3.9
```bash
pip-compile --extra=test --extra=docs --extra=lint --extra=client --output-file=requirements.txt pyproject.toml
```
To update the requirements within the defined ranges, run:
```bash
pip-compile --upgrade --extra=test --extra=docs --extra=lint --extra=client --output-file=requirements.txt pyproject.toml
```
Raw data
{
"_id": null,
"home_page": "",
"name": "cems-nuclei",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "API",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a7/7e/31d978da003554e31a6e4c3ec2f2a349b658107257b613f80310bfb4495b/cems-nuclei-0.5.5.tar.gz",
"platform": null,
"description": "# NUCLEI\n\n[](http://mypy-lang.org/)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n\nThis repository is created by [CEMS BV](https://cemsbv.nl/) and helps the user to access and process API calls to\nthe [NUCLEI](https://nuclei.cemsbv.io/#/) environment.\n\n# Installation\n\nTo install this package, including the `NucleiClient` library and its dependencies, run:\n\n```bash\npip install cems-nuclei[client]\n```\n\nTo skip the installation of the `NucleiClient` library, in case you do not need it (e.g. only use pure requests), run:\n\n```bash\npip install cems-nuclei\n```\n\n## ENV VARS\n\nTo use `nuclei` add the follow ENV vars to your environment. Or provide them when asked.\n\n```\n* NUCLEI_TOKEN\n - Your NUCLEI user token\n```\n\nYou can obtain your `NUCLEI_TOKEN` on [NUCLEI](https://nuclei.cemsbv.io/#/).\nGo to `personal-access-tokens` and create a new user token.\n\n# Contribution\n\n## Environment\n\nWe recommend developing in Python3.9 with a clean virtual environment (using `virtualenv` or `conda`), installing the\nrequirements from the requirements.txt file:\n\nExample using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:\n\n```bash\npython -m venv .env\nsource activate .env/bin/activate\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install -e .\n```\n\n## Documentation\n\nBuild the docs:\n\n```bash\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install .\nsphinx-build -b html docs public\n```\n\nNote: You'll need to set the `NUCLEI_TOKEN` environmental variable.\nYou can get your token at: `https://cemsbv.crux-nuclei.com`\n\n## Format\n\nWe format our code with black and isort.\n\n```bash\nblack --config \"pyproject.toml\" src/nuclei tests\nisort --settings-path \"pyproject.toml\" src/nuclei tests\n```\n\n## Lint\n\nTo maintain code quality we use the GitHub super-linter.\n\nTo run the linters locally, run the `run_super_linters.sh` bash script from the root directory.\n\n## UnitTest\n\nTest the software with the use of coverage:\n\n```bash\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install .\ncoverage run -m pytest\n```\n\n## Requirements\n\nRequirements are autogenerated by `pip-compile` with python 3.9\n\n```bash\npip-compile --extra=test --extra=docs --extra=lint --extra=client --output-file=requirements.txt pyproject.toml\n```\n\nTo update the requirements within the defined ranges, run:\n\n```bash\npip-compile --upgrade --extra=test --extra=docs --extra=lint --extra=client --output-file=requirements.txt pyproject.toml\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 CEMS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python wrapper around NUCLEI's functionality.",
"version": "0.5.5",
"project_urls": {
"repository": "https://github.com/cemsbv/nuclei"
},
"split_keywords": [
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f0633058749dbdb823941863487f646c7b258fe546fa366181fbeff991a4eeb",
"md5": "43dad3b3d3122c9f72dc5bc397c61395",
"sha256": "c3ab779f0b76be48fb16742d1c78e88bcc4585e335b4aa06e93ac7c55aa7411a"
},
"downloads": -1,
"filename": "cems_nuclei-0.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43dad3b3d3122c9f72dc5bc397c61395",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10586,
"upload_time": "2024-01-17T14:49:14",
"upload_time_iso_8601": "2024-01-17T14:49:14.228331Z",
"url": "https://files.pythonhosted.org/packages/2f/06/33058749dbdb823941863487f646c7b258fe546fa366181fbeff991a4eeb/cems_nuclei-0.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a77e31d978da003554e31a6e4c3ec2f2a349b658107257b613f80310bfb4495b",
"md5": "d5a437a0cc1dc95bd22a928e6fa70633",
"sha256": "5f9198630e7472186d52ff0b80192e34170035e1cafc6b5671bf8a0536bdd6d2"
},
"downloads": -1,
"filename": "cems-nuclei-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "d5a437a0cc1dc95bd22a928e6fa70633",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 11738,
"upload_time": "2024-01-17T14:49:15",
"upload_time_iso_8601": "2024-01-17T14:49:15.887413Z",
"url": "https://files.pythonhosted.org/packages/a7/7e/31d978da003554e31a6e4c3ec2f2a349b658107257b613f80310bfb4495b/cems-nuclei-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-17 14:49:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cemsbv",
"github_project": "nuclei",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "cems-nuclei"
}
