Metadata-Version: 2.1
Name: strip.pysondb
Version: 1.2.1
Summary: A stripped-down version of pysondb.
Home-page: https://github.com/Adwaith-Rajesh/strip.pysondb
Author: Adwaith Rajesh
Author-email: adwaithrajesh3180@gmail.com
License: MIT
Description: # strip.pysondb
        
        [![GitHub](https://img.shields.io/github/license/Adwaith-Rajesh/strip.pysondb?style=for-the-badge)](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/LICENSE)
        [![Azure DevOps builds](https://img.shields.io/azure-devops/build/adwaithrajesh/8d11fcc8-9bf7-41cf-95af-bd240456c13e/8?label=azure%20pipeline&style=for-the-badge)](https://dev.azure.com/adwaithrajesh/adwaith/_build?definitionId=8)
        [![PyPI](https://img.shields.io/pypi/v/strip.pysondb?style=for-the-badge)](https://pypi.org/project/strip.pysondb/)
        
        A stripped-down version of [pysondb](https://github.com/fredysomy/pysonDB) by [Fredy Somy](https://github.com/fredysomy).
        
        ---
        
        ## 🎉 Features.
        
        - No third party packages needed
        - No CLI
        - No ImageUtils
        - Use of [python naming conventions](https://www.python.org/dev/peps/pep-0008/#function-and-variable-names) in functions and classes.
        - Just the code required to perform CRUD operation on JSON DB.
        - Users can generate custom id's for their data.
        
        ## ✏️️ Note
        
        Even though it's called a stripped-down version, there are some huge differences in the way this package works.
        
        - The data is not saved to file instantly, instead a methods needs to be called in order to do that.
        - The user is supposed to pass the keys / column name for the DB during initialization of the `DB` class.
        - Some of the new methods that are not derived from PysonDB are,
          - [`pop`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#dbpop_id-str---dictstr-any--none)
          - [`commit`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#saving-to-a-file)
          - [`load`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#load-values-from-a-file)
          - [`values`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#get-the-first-n-values-from-the-db)
          - [`set_id_generator`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#using-a-custom-id-generator)
          - [`id_exists`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#check-whether-an-id-exists-in-the-db)
        
        ---
        
        ## 🔻 Installation
        
        - ### Delete the original pysondb before installing this version. (Might cause conflicts)
        
        - ### From Pypi
          ```commandline
          pip3 install strip.pysondb
          ```
        
        ---
        
        ## 📚 Usage
        
        - ## tl;dr
        
          ```python
          from pysondb import DB
        
          db = DB(keys = ["name", "age"])
          db.add({
              "name": "name1",
              "age": 1
          })
        
          print(db)
        
          ```
        
        ### Click [here](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md) to see the complete docs.
        
        ---
        
        ## 🥰 Contributing to strip.pysondb
        
        Read the **CONTRIBUTING.md** for the code design style and linting preferences.
        
        Once you've gone though follow theses steps.
        
        - Fork this repo.
        - Create a new branch from master. (Very important)
        - Make your required changes with good commit messages.
        - Write the test to make sure that your changes work.
        - Create a pull request.
        - Bug the maintainers until it get merged 😊.
        
        ## 🙊 Have any issue or feature request.
        
        Create an issue or join our Discord server [Here](https://discord.gg/BxMbWzZe2Z).
        
        ---
        
        <h3 align="center"> <img align="center" src="https://forthebadge.com/images/badges/made-with-python.svg" href="https://python.org" ></h3>
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
