Skip to main content

NUCLEI

Checked with mypy Code style: black Imports: isort

This repository is created by CEMS BV and helps the user to access and process API calls to the NUCLEI environment.

Installation

To install this package, including the NucleiClient library and its dependencies, run:

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:

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. Go to Access token and create a new user token.

Contribution

Environment

This project is managed with uv. Install uv, then sync the environment (including all optional extras) and it will create a .venv for you:

uv sync --all-extras

Documentation

Build the docs:

uv sync --extra docs --extra client
uv run 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.

uv run black --config "pyproject.toml" src/nuclei tests
uv run 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:

uv sync --all-extras
uv run coverage run -m pytest

Dependency lock file

Dependencies are locked in uv.lock. To update it after changing pyproject.toml, run:

uv lock

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cems_nuclei-3.2.1.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cems_nuclei-3.2.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file cems_nuclei-3.2.1.tar.gz.

File metadata

  • Download URL: cems_nuclei-3.2.1.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cems_nuclei-3.2.1.tar.gz
Algorithm Hash digest
SHA256 009e7a0a1df7968c4b53897a46d7d17b9891856a2f85618b04c809046254e2bb
MD5 04e3f470683b7f01eee794a2178455a0
BLAKE2b-256 74b7e28c78c48fc9435e20df1cb369ed04e38b8b1ac1f976eb15f6ff2e958dc9

See more details on using hashes here.

Provenance

The following attestation bundles were made for cems_nuclei-3.2.1.tar.gz:

Publisher: release_pypi.yaml on cemsbv/nuclei

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cems_nuclei-3.2.1-py3-none-any.whl.

File metadata

  • Download URL: cems_nuclei-3.2.1-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cems_nuclei-3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62c569fb6b2451a485cd0f6f0126073a10ae4f98ba56ccf7182e2eb169ea4e71
MD5 d718b3d683189ae63bb4a2f36ab688a7
BLAKE2b-256 7ffb8e727b74fe9f28c785068a1f938c695ec9bbfb1746062772b939e8e075d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for cems_nuclei-3.2.1-py3-none-any.whl:

Publisher: release_pypi.yaml on cemsbv/nuclei

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

3.2.1 This release

2 files

3.2.0

2 files

3.1.0

2 files

3.0.1

2 files

3.0.0

2 files

2.0.1

2 files

2.0.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.2

1 file

0.3.1

1 file

0.3.0

1 file

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page