diff options
Diffstat (limited to 'python-acrypt.spec')
| -rw-r--r-- | python-acrypt.spec | 327 |
1 files changed, 327 insertions, 0 deletions
diff --git a/python-acrypt.spec b/python-acrypt.spec new file mode 100644 index 0000000..c97646b --- /dev/null +++ b/python-acrypt.spec @@ -0,0 +1,327 @@ +%global _empty_manifest_terminate_build 0 +Name: python-aCrypt +Version: 0.1.7 +Release: 1 +Summary: Ciphering made easy. +License: MIT License +URL: https://repl.it/@ChezCoder/aCrypt +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a8/11/8d733338e9a1d215558e3289c78fa4e3d44d352272f2f8eb780f62ecc7a3/aCrypt-0.1.7.tar.gz +BuildArch: noarch + + +%description +# aCrypt - Python +Ciphering made easy. + +## Features +- Encode a string into numbers using a secret key +- Decode encoded strings into their original form using a secret key +- Generate a valid aCrypt key + +## Usage +| Usage | Params | Return Value | +| :------------- | :----------------------- | :---------------- | +| `create_key()` | `None: None` | `int: key` | +| `cipher()` | `str: message, int: key` | `str: ciphered` | +| `decipher()` | `str: message, int: key` | `str: deciphered` | + +## Examples +Lets say you have private JSON data that you need to encode: +```python +# lets imagine this is the data +data = { + "username": "ilovecats", + "password": "meow123" +} +``` + +Of course though, writing this un-encoded data can be very unsafe. So the only way to protect it is to cipher it. +```python +from json import dumps, loads +from os import getenv + +data = { + "username": "ilovecats", + "password": "meow123" +} + +# turn the JSON into a string we can encode +data = dumps(data) + +# using a key we can store in our environment variables, we can cipher it +encoded_data = cipher(data, os.getenv("CIPHER_KEY")) # you can also keep the key in a variable, thought this is unsafe as users can just use the key + +# voila! The data has been ciphered: +print(encoded_data) +``` + +And to decipher the data and use it, you can do the reverse: + +```python +from json import dumps, loads +from os import getenv + +# decipher the data +decoded_data = decipher(encoded_data, os.getenv("CIPHER_KEY")) + +# turn the string back into json data +data = loads(decoded_data) + +# now you can use it! +print("Your username is" + data.username + "!") +``` + +## Credits +- Thank you to the repl.it community for providing such amazing services for free. +- Thank you to Atticus Kuhn for pointing out safety concerns on the project. +- Thank you to AmazingMech2418 (https://repl.it/@AmazingMech2418), for showing me the world of cryptography. +- Thank you StealthHydra179 (https://repl.it/@StealthHydra179), for being the only person who cared about programming in my school. +- Thank you Giothecoder (https://repl.it/@Giothecoder), for being there when I needed you most. + + +## Change Log +- 0.0.1 - Cipher was added, deciphering was unfinished +- 0.0.2 - Deciphering finished with lots of bugs +- 0.0.3 - Atticus Kuhn pointed out a safety bug, and thus it was patched +- 0.0.4 - Bugs fixes +- 0.0.5 - Added Credits +- 0.0.6 - AmazingMech2418 pointed out huge safety feature that should be added +- 0.0.7 - Bugs fixes +- 0.0.8 - Test Version +- 0.0.9 - Test Version +- 0.1.0 - Update 0.0.6 was revisited and implemented +- 0.1.1 - Added changelog +- 0.1.3 - Bug fixes +- 0.1.4 - Made key generation more efficient +- 0.1.5 - Added examples + + + +%package -n python3-aCrypt +Summary: Ciphering made easy. +Provides: python-aCrypt +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-aCrypt +# aCrypt - Python +Ciphering made easy. + +## Features +- Encode a string into numbers using a secret key +- Decode encoded strings into their original form using a secret key +- Generate a valid aCrypt key + +## Usage +| Usage | Params | Return Value | +| :------------- | :----------------------- | :---------------- | +| `create_key()` | `None: None` | `int: key` | +| `cipher()` | `str: message, int: key` | `str: ciphered` | +| `decipher()` | `str: message, int: key` | `str: deciphered` | + +## Examples +Lets say you have private JSON data that you need to encode: +```python +# lets imagine this is the data +data = { + "username": "ilovecats", + "password": "meow123" +} +``` + +Of course though, writing this un-encoded data can be very unsafe. So the only way to protect it is to cipher it. +```python +from json import dumps, loads +from os import getenv + +data = { + "username": "ilovecats", + "password": "meow123" +} + +# turn the JSON into a string we can encode +data = dumps(data) + +# using a key we can store in our environment variables, we can cipher it +encoded_data = cipher(data, os.getenv("CIPHER_KEY")) # you can also keep the key in a variable, thought this is unsafe as users can just use the key + +# voila! The data has been ciphered: +print(encoded_data) +``` + +And to decipher the data and use it, you can do the reverse: + +```python +from json import dumps, loads +from os import getenv + +# decipher the data +decoded_data = decipher(encoded_data, os.getenv("CIPHER_KEY")) + +# turn the string back into json data +data = loads(decoded_data) + +# now you can use it! +print("Your username is" + data.username + "!") +``` + +## Credits +- Thank you to the repl.it community for providing such amazing services for free. +- Thank you to Atticus Kuhn for pointing out safety concerns on the project. +- Thank you to AmazingMech2418 (https://repl.it/@AmazingMech2418), for showing me the world of cryptography. +- Thank you StealthHydra179 (https://repl.it/@StealthHydra179), for being the only person who cared about programming in my school. +- Thank you Giothecoder (https://repl.it/@Giothecoder), for being there when I needed you most. + + +## Change Log +- 0.0.1 - Cipher was added, deciphering was unfinished +- 0.0.2 - Deciphering finished with lots of bugs +- 0.0.3 - Atticus Kuhn pointed out a safety bug, and thus it was patched +- 0.0.4 - Bugs fixes +- 0.0.5 - Added Credits +- 0.0.6 - AmazingMech2418 pointed out huge safety feature that should be added +- 0.0.7 - Bugs fixes +- 0.0.8 - Test Version +- 0.0.9 - Test Version +- 0.1.0 - Update 0.0.6 was revisited and implemented +- 0.1.1 - Added changelog +- 0.1.3 - Bug fixes +- 0.1.4 - Made key generation more efficient +- 0.1.5 - Added examples + + + +%package help +Summary: Development documents and examples for aCrypt +Provides: python3-aCrypt-doc +%description help +# aCrypt - Python +Ciphering made easy. + +## Features +- Encode a string into numbers using a secret key +- Decode encoded strings into their original form using a secret key +- Generate a valid aCrypt key + +## Usage +| Usage | Params | Return Value | +| :------------- | :----------------------- | :---------------- | +| `create_key()` | `None: None` | `int: key` | +| `cipher()` | `str: message, int: key` | `str: ciphered` | +| `decipher()` | `str: message, int: key` | `str: deciphered` | + +## Examples +Lets say you have private JSON data that you need to encode: +```python +# lets imagine this is the data +data = { + "username": "ilovecats", + "password": "meow123" +} +``` + +Of course though, writing this un-encoded data can be very unsafe. So the only way to protect it is to cipher it. +```python +from json import dumps, loads +from os import getenv + +data = { + "username": "ilovecats", + "password": "meow123" +} + +# turn the JSON into a string we can encode +data = dumps(data) + +# using a key we can store in our environment variables, we can cipher it +encoded_data = cipher(data, os.getenv("CIPHER_KEY")) # you can also keep the key in a variable, thought this is unsafe as users can just use the key + +# voila! The data has been ciphered: +print(encoded_data) +``` + +And to decipher the data and use it, you can do the reverse: + +```python +from json import dumps, loads +from os import getenv + +# decipher the data +decoded_data = decipher(encoded_data, os.getenv("CIPHER_KEY")) + +# turn the string back into json data +data = loads(decoded_data) + +# now you can use it! +print("Your username is" + data.username + "!") +``` + +## Credits +- Thank you to the repl.it community for providing such amazing services for free. +- Thank you to Atticus Kuhn for pointing out safety concerns on the project. +- Thank you to AmazingMech2418 (https://repl.it/@AmazingMech2418), for showing me the world of cryptography. +- Thank you StealthHydra179 (https://repl.it/@StealthHydra179), for being the only person who cared about programming in my school. +- Thank you Giothecoder (https://repl.it/@Giothecoder), for being there when I needed you most. + + +## Change Log +- 0.0.1 - Cipher was added, deciphering was unfinished +- 0.0.2 - Deciphering finished with lots of bugs +- 0.0.3 - Atticus Kuhn pointed out a safety bug, and thus it was patched +- 0.0.4 - Bugs fixes +- 0.0.5 - Added Credits +- 0.0.6 - AmazingMech2418 pointed out huge safety feature that should be added +- 0.0.7 - Bugs fixes +- 0.0.8 - Test Version +- 0.0.9 - Test Version +- 0.1.0 - Update 0.0.6 was revisited and implemented +- 0.1.1 - Added changelog +- 0.1.3 - Bug fixes +- 0.1.4 - Made key generation more efficient +- 0.1.5 - Added examples + + + +%prep +%autosetup -n aCrypt-0.1.7 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-aCrypt -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.7-1 +- Package Spec generated |