Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

GitHub release

A library for CrackNuts device.
This repository is the Python library for controlling the Cracker device and performing key analysis in the CrackNuts project.

Install

Just run pip install cracknuts or run pip install cracknuts[jupyter] if you are developing in Jupyter.

Then run cracknuts welcome, and it will print the welcome message and version information of CrackNuts.

   ______                           __      _   __           __
  / ____/   _____  ____ _  _____   / /__   / | / /  __  __  / /_   _____
 / /       / ___/ / __ `/ / ___/  / //_/  /  |/ /  / / / / / __/  / ___/
/ /___    / /    / /_/ / / /__   / ,<    / /|  /  / /_/ / / /_   (__  )
\____/   /_/     \__,_/  \___/  /_/|_|  /_/ |_/   \__,_/  \__/  /____/

Welcome to CrackNuts(0.17.0)! 🎉

Here are some commands to get you started:

1. cracknuts tutorials - Open the tutorials to learn more about CrackNuts.
2. cracknuts lab - Launch Jupyter Lab for interactive analysis.
3. cracknuts --help - View detailed command options and usage instructions.

For more information, visit:
- Official website: https://cracknuts.io
- GitHub repository: https://github.com/cracknuts-team/cracknuts
- API documentation: https://api.cracknuts.io

Enjoy exploring CrackNuts! If you need assistance, feel free to check the documentation or ask for help.

Once all the above steps complete without errors, the installation is successful, and you can start using CrackNuts for research and study.

Alternatively, you can use the quick install script. It will install Miniconda, create an environment named cracknuts, and add two CrackNuts shortcuts to the desktop (on Windows) or to the application launcher.

Windows

curl https://raw.githubusercontent.com/cracknuts-team/cracknuts/refs/heads/main/install/win-install.ps1 -o "cracknuts-win-install.ps1"; powershell -ExecutionPolicy Bypass -File ".\cracknuts-win-install.ps1"; del "cracknuts-win-install.ps1"

Linux

curl -sSL https://raw.githubusercontent.com/cracknuts-team/cracknuts/refs/heads/main/install/install.sh | bash

Usage

Visit CrackNuts for more information.

Metadata

Release files for cracknuts 0.31.0b1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cracknuts 0.31.0b1
File Size Uploaded Provenance
cracknuts-0.31.0b1.tar.gz 26.8 MB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for cracknuts 0.31.0b1
File Interpreter ABI Platform
cracknuts-0.31.0b1-py3-none-any.whl Python 3 none any Details

Total release size: 53.8 MB

Release files / cracknuts-0.31.0b1.tar.gz

Download URL cracknuts-0.31.0b1.tar.gz
Size 26.8 MB
Tags Source
SHA-256 checksum
How to use checksums
39769c28909d7be4edef86f710c5fa641c15a510c91174d19a6ec150870debbf
BLAKE2b-256 checksum
How to use checksums
bc8620e04f56c3a471f51fa453425e496a8a83f3b93e7c9e308ae52c77600bad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / cracknuts-0.31.0b1-py3-none-any.whl

Download URL cracknuts-0.31.0b1-py3-none-any.whl
Size 27.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
fa1792168ce571257f9f863f4d18678c51e959bd533e22fd3b28fa384043779f
BLAKE2b-256 checksum
How to use checksums
963e1281f4f263972677dcb481877d319009c2c53b38743964c095f4405cb1f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for cracknuts 0.31.0b1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release
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