Metadata-Version: 2.4
Name: cryptopyx
Version: 0.3.0
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Free Threading
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Typing :: Stubs Only
License-File: LICENSE
Summary: A python cryptography package written in Rust made for speed.
Keywords: cryptography,cipher,encryption,decryption,security
Author-email: Siqi Yan <syan235711@gmail.com>
License-Expression: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/syan212/CryptoPyX/blob/main/CHANGELOG.md
Project-URL: Documentation, https://cryptopyx.readthedocs.io/
Project-URL: Issues, https://github.com/syan212/CryptoPyX/issues
Project-URL: Repository, https://github.com/syan212/CryptoPyX

# CryptoPyX

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![PyPI - Version](https://img.shields.io/pypi/v/cryptopyx?label=PyPI%20Version&color=blue)](https://pypi.org/project/cryptopyx)
[![CI Status](https://github.com/syan212/CryptoPyX/actions/workflows/CI.yml/badge.svg)](https://github.com/syan212/CryptoPyX/actions/workflows/CI.yml)
[![Dependabot Status](https://github.com/syan212/CryptoPyX/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/syan212/CryptoPyX/actions/workflows/dependabot/dependabot-updates)
[![Publish to PyPI Status](https://github.com/syan212/CryptoPyX/actions/workflows/pypi.yml/badge.svg?event=release)](https://github.com/syan212/CryptoPyX/actions/workflows/pypi.yml)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cryptopyx)
[![Licence](https://img.shields.io/github/license/syan212/cryptopyx)](https://github.com/syan212/CryptoPyX/blob/main/LICENSE)

A python cryptography package written in Rust made for speed.

## Example Library Usage

``` python
from cryptopyx.encodings import base32

base32.encode_bytes(b'Hello World')  # b'JBSWY3DPEBLW64TMMQ======'
base32.decode_bytes(b'JBSWY3DPEBLW64TMMQ======')  # b'Hello World'
```

## Example CLI Usage

![image](images/cli.png)

## Installation guide

### Install from PyPI

This package supports Python 3.10 and above

``` shell
pip install cryptopyx
```

See `Building From Source` below for more information.

## Documentation

The documentation is still work in progress, but you can see it here: [Documentation website](https://cryptopyx.readthedocs.io).

## Building From source

To build from source with or without Rust after cloning the repository, simply run

``` shell
pip install .
```

## Licence

This is licensed under MIT licence. See `LICENSE` for full information.


