#########
CryptoPyX
#########
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Ruff
.. image:: https://img.shields.io/pypi/pyversions/cryptopyx
:target: https://pypi.org/project/cryptopyx/
:alt: PyPI - Python Version
.. image:: https://img.shields.io/pypi/v/cryptopyx?label=PyPI%20Version&color=blue
:alt: PyPI - Version
:target: https://pypi.org/project/cryptopyx/#history
.. image:: https://img.shields.io/pypi/dm/cryptopyx?label=PyPI%20Downloads&color=blue
:alt: PyPI - Downloads
:target: https://pypi.org/project/cryptopyx/
.. image:: https://github.com/syan212/CryptoPyX/actions/workflows/CI.yml/badge.svg
:target: https://github.com/syan212/CryptoPyX/actions/workflows/CI.yml
:alt: CI Status
.. image:: https://github.com/syan212/CryptoPyX/actions/workflows/dependabot/dependabot-updates/badge.svg
:target: https://github.com/syan212/CryptoPyX/actions/workflows/dependabot/dependabot-updates
:alt: Dependabot Status
.. image:: https://github.com/syan212/CryptoPyX/actions/workflows/pypi.yml/badge.svg?event=release
:target: https://github.com/syan212/CryptoPyX/actions/workflows/pypi.yml
:alt: Publish to PyPI Status
.. image:: https://img.shields.io/github/license/syan212/cryptopyx
:target: https://github.com/syan212/CryptoPyX/blob/main/LICENSE
:alt: License
A simple python cryptography package written in Rust.
Installation guide
==================
Install from PyPI
::
pip install cryptopyx
Or get the source code from github and build from source.
See `building from source <#building-from-source>`_ for more information.
Example Usage
=============
::
from cryptopyx.ciphers import caesar
caesar.encrypt('ABC', 3) # DEF
caesar.decrypt('DEF', 3) # ABC
Documentation
=============
Due to the fact that there is no documentation, please refer to the code itself for now.
.. _build-from-source:
Building From source
====================
Notice
------
It is possible to install the package without Rust, as maturin can install a temporary Rust toolchain.
However, it is recommended to have Rust installed to avoid any issues.
To build from source without Rust after cloning the repository, run::
pip install maturin
maturin build --release --out dist
pip install dist/cryptopyx-*.whl # You might have to use `pip3` instead of `pip`
Advanced full build instructions
---------------------------------
To build from source, you need to have Python, Rust and Cargo installed.
This package uses `maturin <https://www.maturin.rs/>`_ to build the package.
It requires Python 3.9 or higher and Rust 1.85.0 or higher.
If you don't have Python installed, please refer to <https://www.python.org/downloads/>.
If you don't have Rust and Cargo installed, please refer to <https://www.rust-lang.org/tools/install>.
Then clone the repository
::
git clone https://github.com/syan212/CryptoPyX.git
cd CryptoPyX
The install the build tools using pip (I recommended using a virtual enviroment for this)
::
pip install -r requirements-dev.txt
Then build the package using maturin and install it
::
maturin build --release --out dist
pip install dist/cryptopyx-*.whl # You might have to use `pip3` instead of `pip`
Raw data
{
"_id": null,
"home_page": null,
"name": "cryptopyx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cryptography, cipher, encryption, decryption, security",
"author": null,
"author_email": "Siqi Yan <syan235711@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a1/05/6dba2719072f683a810d7db478fabc5f4a5f95b879b924272c928d9d8694/cryptopyx-0.1.1.tar.gz",
"platform": null,
"description": "#########\nCryptoPyX\n#########\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Ruff\n\n.. image:: https://img.shields.io/pypi/pyversions/cryptopyx\n :target: https://pypi.org/project/cryptopyx/\n :alt: PyPI - Python Version\n\n.. image:: https://img.shields.io/pypi/v/cryptopyx?label=PyPI%20Version&color=blue\n :alt: PyPI - Version\n :target: https://pypi.org/project/cryptopyx/#history\n\n.. image:: https://img.shields.io/pypi/dm/cryptopyx?label=PyPI%20Downloads&color=blue\n :alt: PyPI - Downloads\n :target: https://pypi.org/project/cryptopyx/\n\n.. image:: https://github.com/syan212/CryptoPyX/actions/workflows/CI.yml/badge.svg\n :target: https://github.com/syan212/CryptoPyX/actions/workflows/CI.yml\n :alt: CI Status\n\n.. image:: https://github.com/syan212/CryptoPyX/actions/workflows/dependabot/dependabot-updates/badge.svg\n :target: https://github.com/syan212/CryptoPyX/actions/workflows/dependabot/dependabot-updates\n :alt: Dependabot Status\n\n.. image:: https://github.com/syan212/CryptoPyX/actions/workflows/pypi.yml/badge.svg?event=release\n :target: https://github.com/syan212/CryptoPyX/actions/workflows/pypi.yml\n :alt: Publish to PyPI Status\n\n.. image:: https://img.shields.io/github/license/syan212/cryptopyx\n :target: https://github.com/syan212/CryptoPyX/blob/main/LICENSE\n :alt: License\n\nA simple python cryptography package written in Rust.\n\nInstallation guide\n==================\n\nInstall from PyPI\n\n::\n \n pip install cryptopyx\n\nOr get the source code from github and build from source.\nSee `building from source <#building-from-source>`_ for more information.\n\nExample Usage\n=============\n\n::\n\n from cryptopyx.ciphers import caesar\n caesar.encrypt('ABC', 3) # DEF\n caesar.decrypt('DEF', 3) # ABC\n\n\nDocumentation\n=============\n\nDue to the fact that there is no documentation, please refer to the code itself for now.\n\n.. _build-from-source:\n\nBuilding From source\n====================\n\nNotice\n------\n\nIt is possible to install the package without Rust, as maturin can install a temporary Rust toolchain.\nHowever, it is recommended to have Rust installed to avoid any issues.\n\nTo build from source without Rust after cloning the repository, run:: \n\n pip install maturin\n maturin build --release --out dist\n pip install dist/cryptopyx-*.whl # You might have to use `pip3` instead of `pip`\n\nAdvanced full build instructions\n---------------------------------\n\nTo build from source, you need to have Python, Rust and Cargo installed.\nThis package uses `maturin <https://www.maturin.rs/>`_ to build the package.\nIt requires Python 3.9 or higher and Rust 1.85.0 or higher.\n\nIf you don't have Python installed, please refer to <https://www.python.org/downloads/>.\nIf you don't have Rust and Cargo installed, please refer to <https://www.rust-lang.org/tools/install>.\n\nThen clone the repository\n:: \n\n git clone https://github.com/syan212/CryptoPyX.git\n cd CryptoPyX\n\nThe install the build tools using pip (I recommended using a virtual enviroment for this)\n::\n\n pip install -r requirements-dev.txt\n\nThen build the package using maturin and install it\n::\n\n maturin build --release --out dist\n pip install dist/cryptopyx-*.whl # You might have to use `pip3` instead of `pip`\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple cryptography package written in Rust",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://github.com/syan212/CryptoPyX/blob/main/CHANGELOG.md",
"Repository": "https://github.com/syan212/CryptoPyX",
"issues": "https://github.com/syan212/CryptoPyX/issues"
},
"split_keywords": [
"cryptography",
" cipher",
" encryption",
" decryption",
" security"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5723806dcaf3e26c084039412a236faff6b37d3506328d0c3c66f16bcae03044",
"md5": "8c721cc9c92f7cb444ba5f3b4230f0d5",
"sha256": "11eb9c04a7cbeade00c644e2aca37e2b221e8bee67cc8d85e5f13ba214760d51"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "8c721cc9c92f7cb444ba5f3b4230f0d5",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 220358,
"upload_time": "2025-10-07T20:28:43",
"upload_time_iso_8601": "2025-10-07T20:28:43.347194Z",
"url": "https://files.pythonhosted.org/packages/57/23/806dcaf3e26c084039412a236faff6b37d3506328d0c3c66f16bcae03044/cryptopyx-0.1.1-cp39-abi3-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "052c679b3237c59741896ab4d3012e1d7ab5c9d413c3607e92477e9292833342",
"md5": "ecdd625b83c7defd94e5bf681508d2d1",
"sha256": "c75120f4e2c3bd855f01561f1ca9d603150d9a7c6eb759d3f42e3acac8d93e39"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "ecdd625b83c7defd94e5bf681508d2d1",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 214117,
"upload_time": "2025-10-07T20:28:44",
"upload_time_iso_8601": "2025-10-07T20:28:44.676589Z",
"url": "https://files.pythonhosted.org/packages/05/2c/679b3237c59741896ab4d3012e1d7ab5c9d413c3607e92477e9292833342/cryptopyx-0.1.1-cp39-abi3-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "caee32a4bbc583efb9b092e676b5ab63f11b221bf4d24d7c92562afcd4d8b6ec",
"md5": "d93dbd86d49b6839e952ffb335d1cdd1",
"sha256": "0a2a4ddf80209f81ed7c3b8c7d4312611632bb98db3ab7a29aac705043658c05"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_aarch64.whl",
"has_sig": false,
"md5_digest": "d93dbd86d49b6839e952ffb335d1cdd1",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 239533,
"upload_time": "2025-10-07T20:28:47",
"upload_time_iso_8601": "2025-10-07T20:28:47.184109Z",
"url": "https://files.pythonhosted.org/packages/ca/ee/32a4bbc583efb9b092e676b5ab63f11b221bf4d24d7c92562afcd4d8b6ec/cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b752d30040562922c4f54802fd9d1c78b330ac20d97f63438f9fd325244da0f8",
"md5": "3af15cb58897319f46c5852855d12c91",
"sha256": "60dbeda7f9faf864da74e014217d8e758124806f54075f661e8ea8b20331c90e"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_armv7l.whl",
"has_sig": false,
"md5_digest": "3af15cb58897319f46c5852855d12c91",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 248608,
"upload_time": "2025-10-07T20:28:49",
"upload_time_iso_8601": "2025-10-07T20:28:49.694744Z",
"url": "https://files.pythonhosted.org/packages/b7/52/d30040562922c4f54802fd9d1c78b330ac20d97f63438f9fd325244da0f8/cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0092a2faee75988646c610d9e8db84332c5c16dc2c2c6ce1c250623501ac5e75",
"md5": "f3ea5dc3c0c024a4bece6d2f42542c13",
"sha256": "2b7443cf5f001c97ccf5cd2973af9a13508e8fcd07465e08b208ddc1a606f274"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_i686.whl",
"has_sig": false,
"md5_digest": "f3ea5dc3c0c024a4bece6d2f42542c13",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 259478,
"upload_time": "2025-10-07T20:28:50",
"upload_time_iso_8601": "2025-10-07T20:28:50.929865Z",
"url": "https://files.pythonhosted.org/packages/00/92/a2faee75988646c610d9e8db84332c5c16dc2c2c6ce1c250623501ac5e75/cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e35d4bb841143f9a0b45b213c631cfa97bc56d69724903ee8015877e52aecca3",
"md5": "b27b03188a3ff469f2b39e8d4c08cf07",
"sha256": "048f8a1249e8582c6050dc9f07a29c8e3294d48e190c29cf20bb7743cf91a6f9"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "b27b03188a3ff469f2b39e8d4c08cf07",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 248900,
"upload_time": "2025-10-07T20:28:52",
"upload_time_iso_8601": "2025-10-07T20:28:52.165967Z",
"url": "https://files.pythonhosted.org/packages/e3/5d/4bb841143f9a0b45b213c631cfa97bc56d69724903ee8015877e52aecca3/cryptopyx-0.1.1-cp39-abi3-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ad85d2d093693f32183d396437721c45d67a92f4b7a13b058d0bb22f28b7b0d5",
"md5": "8284320aae5a028b28f50ad97b9773d2",
"sha256": "f70ad4059d7b23e7d256b688153bb6c5519d7164f5bfdc91f31607796921045a"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-win32.whl",
"has_sig": false,
"md5_digest": "8284320aae5a028b28f50ad97b9773d2",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 104974,
"upload_time": "2025-10-07T20:28:54",
"upload_time_iso_8601": "2025-10-07T20:28:54.084867Z",
"url": "https://files.pythonhosted.org/packages/ad/85/d2d093693f32183d396437721c45d67a92f4b7a13b058d0bb22f28b7b0d5/cryptopyx-0.1.1-cp39-abi3-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "80a20b712870cf26f385cea038a7a11f8834fd81a27ffbb007616234b9a8e2ce",
"md5": "b95bf0b91b29225c1e6475e87727a891",
"sha256": "73b001766d72d18f1cf259dcd95fe1a8d81b251d798c5b8253fef83dc453cfc2"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1-cp39-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "b95bf0b91b29225c1e6475e87727a891",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 109916,
"upload_time": "2025-10-07T20:28:55",
"upload_time_iso_8601": "2025-10-07T20:28:55.510981Z",
"url": "https://files.pythonhosted.org/packages/80/a2/0b712870cf26f385cea038a7a11f8834fd81a27ffbb007616234b9a8e2ce/cryptopyx-0.1.1-cp39-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a1056dba2719072f683a810d7db478fabc5f4a5f95b879b924272c928d9d8694",
"md5": "cdfe2f1dedf15c5ed0e56b53bb5c0326",
"sha256": "36eb7aa53988dd84404386730cf4ea77d83db0e3363a8366a3e90f853ad341c1"
},
"downloads": -1,
"filename": "cryptopyx-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "cdfe2f1dedf15c5ed0e56b53bb5c0326",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15172,
"upload_time": "2025-10-07T20:28:56",
"upload_time_iso_8601": "2025-10-07T20:28:56.541448Z",
"url": "https://files.pythonhosted.org/packages/a1/05/6dba2719072f683a810d7db478fabc5f4a5f95b879b924272c928d9d8694/cryptopyx-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-07 20:28:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "syan212",
"github_project": "CryptoPyX",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cryptopyx"
}
JSON
