path: root/python-oh-my-pickledb.spec

%global _empty_manifest_terminate_build 0
Name:		python-oh-my-pickledb
Version:	0.4.2
Release:	1
Summary:	Oh-My-PickleDB is an open source key-value store using Python's json module
License:	GNU General Public License v3 (GPLv3)
URL:		https://tory1103.github.io/oh-my-pickledb/
Source0:	https://mirrors.aliyun.com/pypi/web/packages/6e/11/fd3c58f9576d475c96381eec97011a65585503ff744e49fd7f086b6ed919/oh-my-pickledb-0.4.2.tar.gz
BuildArch:	noarch

Requires:	python3-cryptography
Requires:	python3-fire
Requires:	python3-pysem-converters

%description
<p align="center"> 
oh-my-pickleDB is a lightweight, fast, and intuitive data manager written in python
    <br> 
</p>
## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](./TODO.md)
- [Contributing](./CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
- [Useful Links](#links)
## 🧐 About <a name = "about"></a>
oh-my-pickleDB is an improved version of [PickleDB](https://github.com/patx/pickledb), with notable differences compared to the original. Most important differences are:
  - Cryptographic utils - Encrypt/Decrypt data content using [FERNET](https://cryptography.io/en/latest/fernet/) symmetric encryption
  - Code improvements - More readable documentation, improved code, etc...
  - Data conversions - Byte, json, or str conversions
  - More flexibility - Save/load data as bytes, json or str, you decide!
  - Utilities - Export data as XML
## 🏁 Getting Started <a name = "getting_started"></a>
### Prerequisites
```
python~=3.9
cryptography~=3.4.8
setuptools~=58.1.0
fire~=0.4.0
```
### Installing
```bash
# Using python pip
$ pip install oh-my-pickledb
# Using git
$ git clone https://github.com/tory1103/oh-my-pickledb.git
$ cd oh-my-pickledb
$ pip install -r requirements.txt
$ python setup.py install
```
## 🔧 Running the tests <a name = "tests"></a>
Tests are found on [tests](./tests) folder.
<br>
In future versions, tests will be added inside code documentation as multi-row comments.
### Break down into end to end tests
```bash
cd /tests
python3 <test_name>.py
```
## 🎈 Usage <a name="usage"></a>
```python
from my_pickledb import PickleDB
database = PickleDB("test.json")  # PickleDB object
database.set('key', 'value')  # Creates new key and value
database.get('key')  # Must return 'value'
database.save.as_json()  # Must save database to file on specified path
```
## 🚀 Deployment <a name = "deployment"></a>
oh-my-pickleDB is a python library, when installed, just import it to your project.
```python
import my_pickledb
from my_pickledb import *
```
## ⛏️ Built Using <a name = "built_using"></a>
- Python
- Json
- Data Structures
## ✍️ Authors <a name = "authors"></a>
- [@tory1103](https://github.com/tory1103) - Idea, Concept & Initial work
See also the list of [contributors](https://github.com/tory1103/oh-my-pickledb/contributors) who participated in this project.
<p align="center">
  <a href="https://github.com/tory1103/oh-my-pickledb/graphs/contributors">
    <img src="https://contributors-img.web.app/image?repo=tory1103/oh-my-pickledb"  alt=""/>
  </a>
</p>
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
- [json](https://www.json.org/json-en.html) 
- [xml](https://en.wikipedia.org/wiki/Extensible_Markup_Language)
- [csv](https://en.wikipedia.org/wiki/Comma-separated_values)
## ✨ Useful links <a name = "links"></a>
- [Website](https://tory1103.github.io/oh-my-pickledb/)
- [Docs](https://tory1103.github.io/oh-my-pickledb/docs.html)
- [Pypi](https://pypi.org/project/oh-my-pickledb/)

%package -n python3-oh-my-pickledb
Summary:	Oh-My-PickleDB is an open source key-value store using Python's json module
Provides:	python-oh-my-pickledb
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-oh-my-pickledb
<p align="center"> 
oh-my-pickleDB is a lightweight, fast, and intuitive data manager written in python
    <br> 
</p>
## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](./TODO.md)
- [Contributing](./CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
- [Useful Links](#links)
## 🧐 About <a name = "about"></a>
oh-my-pickleDB is an improved version of [PickleDB](https://github.com/patx/pickledb), with notable differences compared to the original. Most important differences are:
  - Cryptographic utils - Encrypt/Decrypt data content using [FERNET](https://cryptography.io/en/latest/fernet/) symmetric encryption
  - Code improvements - More readable documentation, improved code, etc...
  - Data conversions - Byte, json, or str conversions
  - More flexibility - Save/load data as bytes, json or str, you decide!
  - Utilities - Export data as XML
## 🏁 Getting Started <a name = "getting_started"></a>
### Prerequisites
```
python~=3.9
cryptography~=3.4.8
setuptools~=58.1.0
fire~=0.4.0
```
### Installing
```bash
# Using python pip
$ pip install oh-my-pickledb
# Using git
$ git clone https://github.com/tory1103/oh-my-pickledb.git
$ cd oh-my-pickledb
$ pip install -r requirements.txt
$ python setup.py install
```
## 🔧 Running the tests <a name = "tests"></a>
Tests are found on [tests](./tests) folder.
<br>
In future versions, tests will be added inside code documentation as multi-row comments.
### Break down into end to end tests
```bash
cd /tests
python3 <test_name>.py
```
## 🎈 Usage <a name="usage"></a>
```python
from my_pickledb import PickleDB
database = PickleDB("test.json")  # PickleDB object
database.set('key', 'value')  # Creates new key and value
database.get('key')  # Must return 'value'
database.save.as_json()  # Must save database to file on specified path
```
## 🚀 Deployment <a name = "deployment"></a>
oh-my-pickleDB is a python library, when installed, just import it to your project.
```python
import my_pickledb
from my_pickledb import *
```
## ⛏️ Built Using <a name = "built_using"></a>
- Python
- Json
- Data Structures
## ✍️ Authors <a name = "authors"></a>
- [@tory1103](https://github.com/tory1103) - Idea, Concept & Initial work
See also the list of [contributors](https://github.com/tory1103/oh-my-pickledb/contributors) who participated in this project.
<p align="center">
  <a href="https://github.com/tory1103/oh-my-pickledb/graphs/contributors">
    <img src="https://contributors-img.web.app/image?repo=tory1103/oh-my-pickledb"  alt=""/>
  </a>
</p>
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
- [json](https://www.json.org/json-en.html) 
- [xml](https://en.wikipedia.org/wiki/Extensible_Markup_Language)
- [csv](https://en.wikipedia.org/wiki/Comma-separated_values)
## ✨ Useful links <a name = "links"></a>
- [Website](https://tory1103.github.io/oh-my-pickledb/)
- [Docs](https://tory1103.github.io/oh-my-pickledb/docs.html)
- [Pypi](https://pypi.org/project/oh-my-pickledb/)

%package help
Summary:	Development documents and examples for oh-my-pickledb
Provides:	python3-oh-my-pickledb-doc
%description help
<p align="center"> 
oh-my-pickleDB is a lightweight, fast, and intuitive data manager written in python
    <br> 
</p>
## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](./TODO.md)
- [Contributing](./CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
- [Useful Links](#links)
## 🧐 About <a name = "about"></a>
oh-my-pickleDB is an improved version of [PickleDB](https://github.com/patx/pickledb), with notable differences compared to the original. Most important differences are:
  - Cryptographic utils - Encrypt/Decrypt data content using [FERNET](https://cryptography.io/en/latest/fernet/) symmetric encryption
  - Code improvements - More readable documentation, improved code, etc...
  - Data conversions - Byte, json, or str conversions
  - More flexibility - Save/load data as bytes, json or str, you decide!
  - Utilities - Export data as XML
## 🏁 Getting Started <a name = "getting_started"></a>
### Prerequisites
```
python~=3.9
cryptography~=3.4.8
setuptools~=58.1.0
fire~=0.4.0
```
### Installing
```bash
# Using python pip
$ pip install oh-my-pickledb
# Using git
$ git clone https://github.com/tory1103/oh-my-pickledb.git
$ cd oh-my-pickledb
$ pip install -r requirements.txt
$ python setup.py install
```
## 🔧 Running the tests <a name = "tests"></a>
Tests are found on [tests](./tests) folder.
<br>
In future versions, tests will be added inside code documentation as multi-row comments.
### Break down into end to end tests
```bash
cd /tests
python3 <test_name>.py
```
## 🎈 Usage <a name="usage"></a>
```python
from my_pickledb import PickleDB
database = PickleDB("test.json")  # PickleDB object
database.set('key', 'value')  # Creates new key and value
database.get('key')  # Must return 'value'
database.save.as_json()  # Must save database to file on specified path
```
## 🚀 Deployment <a name = "deployment"></a>
oh-my-pickleDB is a python library, when installed, just import it to your project.
```python
import my_pickledb
from my_pickledb import *
```
## ⛏️ Built Using <a name = "built_using"></a>
- Python
- Json
- Data Structures
## ✍️ Authors <a name = "authors"></a>
- [@tory1103](https://github.com/tory1103) - Idea, Concept & Initial work
See also the list of [contributors](https://github.com/tory1103/oh-my-pickledb/contributors) who participated in this project.
<p align="center">
  <a href="https://github.com/tory1103/oh-my-pickledb/graphs/contributors">
    <img src="https://contributors-img.web.app/image?repo=tory1103/oh-my-pickledb"  alt=""/>
  </a>
</p>
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
- [json](https://www.json.org/json-en.html) 
- [xml](https://en.wikipedia.org/wiki/Extensible_Markup_Language)
- [csv](https://en.wikipedia.org/wiki/Comma-separated_values)
## ✨ Useful links <a name = "links"></a>
- [Website](https://tory1103.github.io/oh-my-pickledb/)
- [Docs](https://tory1103.github.io/oh-my-pickledb/docs.html)
- [Pypi](https://pypi.org/project/oh-my-pickledb/)

%prep
%autosetup -n oh-my-pickledb-0.4.2

%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-oh-my-pickledb -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.2-1
- Package Spec generated