Merge branch 'dev' into main

# Conflicts:
#	docs/source/examples/index.rst

Author: joonas-yoon

CHANGELOG.md

@@ -9,6 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Thanks for getting this release out! please stay tuned :)
 
+## [0.2.0] - 2022-12-26
+
+### Added
+
+- Unit tests for getters.
+- `Database` read items from serialized JSON file.
+
+### Changed
+
+- Remove `Client`. use methods on `Database` instead of.
+
 ## [0.1.1] - 2022-12-26
 
 ### Added
@@ -36,6 +47,7 @@ Also this is not stable, so under alpha-test.
 - Set up files to being python package
 - Organized direcotries
 
-[Unreleased]: https://github.com/joonas-yoon/json-as-db/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/joonas-yoon/json-as-db/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/joonas-yoon/json-as-db/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/joonas-yoon/json-as-db/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/joonas-yoon/json-as-db/releases/tag/v0.1.0

docs/source/conf.py

@@ -19,7 +19,7 @@
 project = 'json-as-db'
 copyright = f'2022-{datetime.now().year}, Joonas Yoon'
 author = 'Joonas'
-release = '0.1.1'
+release = '0.2.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/examples/database/basic.rst

@@ -139,22 +139,35 @@ When ``commit()``, it saves its states and all items at that time. Using
     [{'type': 'Orange'}]
 
 
+Load
+^^^^
+
+You can get the `Database` object from local JSON formatted file.
+
+This method reads JSON file from directory where given path. In
+following example, it reads the file from ``path/dir/sample.json``.
+
+.. code-block:: python
+
+    >>> db.load('path/dir/sample.json')
+    {'data': {'2g4kaFAiDBPchz66HNPsZa': {'type': 'Orange'}}, 'creator': 'json_as_db', 'created_at': '2022-12-25T14:23:28.906103', 'version': '1.0.0', 'updated_at': '2022-12-25T14:23:28.906103'}
+
+
 Save
 ^^^^
 
-Save `Database` into file as JSON format. You can read from this saved file
-by getting methods with `Client` class.
+Save `Database` into file as JSON format. You can read from this saved file.
 
 .. code-block:: python
 
-    >>> await db.save()
+    >>> db.save()
 
 It supports keyword parameters for JSON formatter and options to file saving.
 Please refer to the document page of modules in details.
 
 .. code-block:: python
 
-    >>> await db.save(file_kwds={'encoding': 'utf-8'}, json_kwds={'indent': 4})
+    >>> db.save(file_kwds={'encoding': 'utf-8'}, json_kwds={'indent': 4})
 
 then you can see the file content as like the following,
 

docs/source/examples/index.rst

@@ -4,68 +4,6 @@ Examples
 .. toctree::
    :maxdepth: 2
 
-Client
-------
-
-Constructor
-^^^^^^^^^^^
-
-`Client` manages with root directory where contains JSON files for database.
-
-When given ``root_dir`` as like ``Client(root_dir='path/dir')``, `Client` makes
-an empty directory with given path ``path/dir``.
-
-.. code-block:: python
-
-    from json_as_db import Client
-
-    client = Client('path/dir')
-
-
-Create Database
-^^^^^^^^^^^^^^^
-
-The name of database means the name of JSON file. so `Client` creates an empty
-file with JSON format: ``path/dir/sample.json``.
-
-The ``create_database`` method returns an instance of `Database` type, and you
-can deal with this object just like dictionary.
-
-.. code-block:: python
-
-    >>> await client.create_database('sample')
-    {'data': {}, 'creator': 'json_as_db', 'created_at': '2022-12-25T14:23:28.906103', 'version': '1.0.0', 'updated_at': '2022-12-25T14:23:28.906103'}
-
-
-Get Database from file
-^^^^^^^^^^^^^^^^^^^^^^
-
-After create database with the below creating method, using file name as its
-database name, you can get it from local JSON formatted file as `Database`
-object.
-
-This method reads and opens JSON file from directory where `Client` knows. In
-following example, `Client` read the file from ``path/dir/sample.json``.
-
-.. code-block:: python
-
-    >>> await client.get_database('sample')
-    {'data': {}, 'creator': 'json_as_db', 'created_at': '2022-12-25T14:23:28.906103', 'version': '1.0.0', 'updated_at': '2022-12-25T14:23:28.906103'}
-
-
-Remove Database
-^^^^^^^^^^^^^^^
-
-.. warning::
-    Please be aware of that file can not be recovered after running.
-
-To remove local JSON file using `Client`, you can run this ``remove_database``
-method.
-
-.. code-block:: python
-
-    client.remove_database('sample')
-
 
 Database
 --------
@@ -75,7 +13,28 @@ except only for some of setters.
 
 .. _dictionary: https://docs.python.org/3/library/stdtypes.htmldict
 
-So you can use them as dictionary-like. please see the following examples.
+So you can use them as dictionary-like, including useful CRUD methods and more.
+
+.. code-block:: python
+
+    >>> from json_as_db import Database
+    >>> db = Database()
+    >>> db.add([
+    ...   { "id": 1001, "type": "Regular" },
+    ...   { "id": 1002, "type": "Chocolate" }
+    ... ])
+    ["aT7kM2pW8L7JisSkNjpAhr", "RUJGcVBFANvNRReXa8U3En"]
+    >>> db.get("aT7kM2pW8L7JisSkNjpAhr")
+    {"id": 1001, "type": "Regular"}
+    >>> db.count()
+    2
+    >>> db.all()
+    [{"id": 1001, "type": "Regular"}, {"id": 1002, "type": "Chocolate"}]
+    >>> db.save('path/dir/file.json')
+
+
+Moreover, `Database` provides and supports many operations.
+Please see the following examples.
 
 .. toctree::
    :maxdepth: 2

docs/source/modules/client.rst

@@ -1,8 +1,10 @@
 Modules
 =======
 
-.. toctree::
-   :maxdepth: 2
+Database
+--------
 
-   client
-   database
+.. automodule:: json_as_db.Database
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/database.rst

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "json_as_db"
-version = "0.1.1"
+version = "0.2.0"
 description = "Using JSON as very lightweight database"
 readme = "README.md"
 license = "MIT"