Merge pull request #21 from saurabh0719/v0.5.2-develop

Merge V0.5.2 develop

CONTRIBUTING.md

@@ -7,6 +7,8 @@ Before contributing ensure you've read and understood the [documentation](https:
   - If you're reporting a bug, please include steps (or code) to reproduce the bug.
   - If you're issuing a feature request, please mention why it will be useful or the use case it solves.
   - If you intend to implement the new feature request OR fix a bug yourself, then give a brief outline of the proposed solution.
+
+* Fork the `main` branch for making your changes.
 
 * You can issue a new [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the `main` branch that closes the issue *after* you've been assigned.
   - Any non-trivial pull request without having opened an earlier issue will be closed.

README.md

@@ -6,7 +6,6 @@
 
 </div>
 
-
 <div align="center">
     <p>Elara DB is an easy to use, lightweight NoSQL database written for python that can also be used as a fast in-memory cache for JSON-serializable data. Includes various methods and features to manipulate data structures in-memory, protect database files and export data.</p>
 </div>
@@ -15,7 +14,7 @@
 $ pip install elara
 ```
 
-* Latest - `v0.5.1`
+* Latest - `v0.5.2`
 
 Go through the [release notes](#releases) for details on upgrades as breaking changes might happen between version upgrades while Elara is in beta.
 
@@ -319,6 +318,8 @@ print(cache.get("obj").num)
 
 * Elara uses checksums and a file version flag to verify database file integrity.
 
+All database writes are atomic (uses the [safer](https://github.com/rec/safer) library).
+
 [Go back to the table of contents](#contents)
 
 <hr>
@@ -484,14 +485,16 @@ $ python -m unittest -v
 
 - `cryptography`
 - `msgpack`
+- `safer`
 
 <hr>
 
 <span id="releases"></span>
 ## Release notes 
 
 * Latest - `v0.5.x` 
-    - `v0.5.1` - No breaking changes
+    - `v0.5.2` - No breaking changes
+    - `v0.5.1`
     - `v0.5.0`
 
 `v0.5.x` comes with an internal re-architecture that allows for much better caching and granular control on item expiry. No breaking changes from `v0.4.x`.
@@ -512,8 +515,16 @@ View Elara's [release history](https://github.com/saurabh0719/elara/releases/).
 
 <span id="contrib"></span>
 ## Contributors :
-Original author and maintainer - Saurabh Pujari
+Original author and maintainer - [Saurabh Pujari](https://github.com/saurabh0719)
+
 <br>
-Logo design - Jonah Eapen
+
+Logo design - [Jonah Eapen](https://mobile.twitter.com/jonaheapen98)
+
+
+Open source contributors :
+
+* [DarthUdp](https://github.com/DarthUdp)
+* [AdityaKotwal100](https://github.com/AdityaKotwal100)
 
 [Go back to the table of contents](#contents)

README.rst

@@ -196,6 +196,7 @@ Note - In ``exe_cache``, the ``path`` parameter is a required argument in case y
 
 Similarly, ``lnew(key, max_age=None)``, ``hnew(key, max_age=None)`` (read the API reference) and ``getset(key, value, max_age=None)``, all accept the optional ``max_age`` argument.
 
+
 .. code:: python
 
    import elara 
@@ -310,6 +311,8 @@ as long as they are ``in-memory`` and ``not persisted in the file``, as that wou
 -  To persist a simple object as a dictionary, use the ``__dict__`` attribute.
 -  Elara uses checksums and a file version flag to verify database file integrity.
 
+All database writes are atomic (uses the safer library).
+
 API reference
 -------------
 
@@ -511,14 +514,16 @@ Dependencies
 
 -  ``cryptography``
 -  ``msgpack``
+-  ``safer``
 
 
 Releases notes
 --------------
 
 -  Latest - ``v0.5.x``
 
-   -  ``v0.5.1`` - No breaking changes
+   -  ``v0.5.2`` - No breaking changes
+   -  ``v0.5.1``
    -  ``v0.5.0``
 
 ``v0.5.x`` comes with an internal re-architecture that allows for much better caching and granular control on item expiry.
@@ -540,5 +545,10 @@ View Elara's release history
 Contributors 
 ------------
 
-| Original author and maintainer - Saurabh Pujari
-| Logo design - Jonah Eapen
+| Original author and maintainer - `Saurabh Pujari <https://github.com/saurabh0719>`__.
+| Logo design - `Jonah Eapen <https://github.com/jonaheapen98>`__.
+
+Open source contributors : 
+
+-  `DarthUdp <https://github.com/DarthUdp>`__.
+-  `AdityaKotwal100 <https://github.com/AdityaKotwal100>`__.

settings.json

@@ -1,5 +1,5 @@
 {
-    "branch": "v0.5.1-develop",
+    "branch": "v0.5.2-develop",
     "message": "Add files via upload",
-    "log": 1
+    "log": 0
 }

setup.py

@@ -6,7 +6,7 @@
 setup(
     name="elara",
     packages=["elara"],
-    version="0.5.1",
+    version="0.5.2",
     license="three-clause BSD",
     description="Elara DB is an easy to use, lightweight NoSQL database written for python that can also be used as a fast in-memory cache for JSON-serializable data. Includes various methods and features to manipulate data structures in-memory, protect database files and export data.",
     long_description=long_description,
@@ -38,3 +38,4 @@
         "Programming Language :: Python",
     ],
 )
+