Metadata-Version: 2.4
Name: cryptopyx
Version: 0.1.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 :: 1 - Planning
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
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 :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: POSIX :: Linux
Classifier: Typing :: Typed
License-File: LICENSE
Summary: A simple cryptography package written in Rust
Keywords: cryptography,cipher,encryption,decryption,security
Author-email: Siqi Yan <syan235711@gmail.com>
License-Expression: MIT
Requires-Python: >=3.9
Description-Content-Type: text/x-rst; charset=UTF-8
Project-URL: Repository, https://github.com/syan212/CryptoPyX
Project-URL: issues, https://github.com/syan212/CryptoPyX/issues
Project-URL: Changelog, https://github.com/syan212/CryptoPyX/blob/main/CHANGELOG.md

#########
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?branch=main
    :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: GitHub License

**Notice**:

    **This is still under early development!**

A simple python cryptography package.

Installation guide
------------------

Install from PyPI

::

    pip install cryptopyx

Or install from github for the latest version

::

    git clone https://github.com/syan212/CryptoPyX.git
    cd CryptoPyX
    pip install .

Example Usage
-------------

::

    from cryptopyx.ciphers import caesar
    caesar.encrypt('ABC', 3) # DEF
    caesar.decrypt('DEF', 3) # ABC


Documentation
-------------

It's nonexistent. Looking through the code should be the best method. :/

