Metadata-Version: 2.1
Name: FamousCipherAlgorithms
Version: 0.1.4
Summary: FamousCipherAlgorithms is a Python package for implementing a variety of cryptographic ciphers and encryption methods, designed to provide secure and reliable data protection.
Project-URL: Repository, https://github.com/MobinNesari81/Famous-Cipher-Algorithms
Project-URL: Documentation, https://famous-cipher-algorithm.readthedocs.io/en/latest/index.html
Author-email: Mobin Nesari <mobinnesari81@gmail.com>, Mohammad Mehdi Begmaz <mohammadmehdi.begmaz@gmail.com>
Maintainer-email: Mobin Nesari <mobinnesari@gmail.com>, Mohammad Mehdi Begmaz <mohammadmehdi.begmaz@gmail.com>
License-File: LICENSE
Keywords: Algorithms,Cipher,Cryptography,Decrypt,Encrypt
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: numpy<=1.21.5
Description-Content-Type: text/markdown

# Famous Cipher Algorithms
<img src="https://github.com/MobinNesari81/Famous-Cipher-Algorithms/blob/main/Logos/FCA-light.svg?raw=true" align='center'>

![PyPI](https://badge.fury.io/py/FamousCipherAlgorithms)

FamousCipherAlgorithms is a Python package that implements several classic cipher algorithms. The package currently includes the following algorithms:
- Affine
- Shift
- Hill
- Permutation
- Playfair
- Vigenere
- Rail Fence

## Installation
The package can be easily installed using pip:
```
pip install FamousCipherAlgorithms
```

## Usage
You can import `FamousCipherAlgorithms` in two ways:
1. Import entire package
    ```python
    import FamousCipherAlgorithms as FCA
    ```
2. Import specific algorithms
    ```python
    from FamousCipherAlgorithms import AffineCipher, ShiftCipher
    ```

## Requirements
- `Python >= 3.9`
- `NumPy <= 1.21.5`

## Documentation
Detailed documentation for each algorithm is available in the <a href="https://famous-cipher-algorithm.readthedocs.io/en/latest/index.html"> document</a>.

## Contributing
Contributions are always welcome! If you have any suggestions, bug reports, or pull requests, please feel free to open an issue on GitHub.

## License
This package is licensed under the MIT license. See the <a href="https://github.com/MobinNesari81/Famous-Cipher-Algorithms/blob/main/LICENSE">LICENSE</a> file for more details.

Copyright © 2023, <a href="https://www.linkedin.com/in/mobin-nesari/">Mobin Nesari</a> & <a href="https://www.linkedin.com/in/mohammad-mahdi-begmaz-69665a243/">Mohammad Mehdi Begmaz</a>