Merge branch 'release/v0.0.7'

Author: klich3

.gitignore

@@ -1,2 +1,2 @@
 __pycache__
-src/Rocketstore/test
+.venv

CITATION.cff

@@ -17,4 +17,4 @@ keywords:
   - file
   - rocket
 license: MIT
-version: 0.0.6
+version: 0.0.7

MANIFEST.in

@@ -4,4 +4,6 @@ include README.md
 include *.toml
 recursive-include src *.py
 recursive-include src/Rocketstore *.py
-recursive-include src/Rocketstore/utils *.py
+recursive-include src/Rocketstore/utils *.py
+prune */__pycache__
+recursive-exclude Samples/*

README.md

@@ -48,18 +48,31 @@ Compare Rocket-Store, SQL and file system terms:
 To use Rocketstore, you must first import the library:
 
 ```python
-from Rocketstore import Rocketstore, _FORMAT_JSON
+from Rocketstore import Rocketstore
 
 rs = Rocketstore()
+```
+
+usage of constants:
+```python
+
+#method 1:
+rs = Rocketstore()
+rs.post(..., rs._FORMAT_JSON)
+
+#or 
+
+rs.post(..., Rocketstore._FORMAT_JSON)
 
 ```
 
+
 ### Post
 
 ```python
-rs.post(collection="delete_fodders1", key="1", record={"some":"json input"}, flags=_FORMAT_JSON)
+rs.post(collection="delete_fodders1", key="1", record={"some":"json input"}, flags=Rocketstore._FORMAT_JSON)
 # or
-rs.post("delete_fodders1", "1", {"some":"json input"}, _FORMAT_JSON)
+rs.post("delete_fodders1", "1", {"some":"json input"}, Rocketstore._FORMAT_JSON)
 ```
 
 Stores a record in a collection identified by a unique key
@@ -153,10 +166,10 @@ __Options__:
   * data_format: Specify which format the records are stored in. Values are: _FORMAT_NATIVE - default. and RS_FORMAT_JSON - Use JSON data format.
 
 ```python
-rs.options(data_format=_FORMAT_JSON)
+rs.options(data_format=Rocketstore._FORMAT_JSON)
 # or
 rs.options(**{
-  "data_format": _FORMAT_JSON,
+  "data_format": Rocketstore._FORMAT_JSON,
   ...
 })
 ```

Samples/Post/README.md renamed to Samples/README.md

@@ -1,5 +1,9 @@
 # Sample implementation
 
+Files: 
+    * `generial`: post, get, count, delete
+    * `post`: post 
+
 1) create virtual environment `virtual ./.venv`
 2) activate it ` . ./venv/bin/activate`
 3) install dependencies `pip install Rocket-Store`

src/Rocketstore/example.py renamed to Samples/generic_example.py

@@ -9,19 +9,20 @@
 Docs: documentation
 """
 
-from .Rocketstore import Rocketstore, _FORMAT_JSON, _FORMAT_NATIVE, _FORMAT_XML, _ADD_AUTO_INC, _ORDER_DESC
+from Rocketstore import Rocketstore
 
-rs = Rocketstore(**{"data_storage_area": "./webapp",
-                    "data_format": _FORMAT_JSON})
+rs = Rocketstore(**{"data_storage_area": "./test",
+                    "data_format": Rocketstore._FORMAT_JSON})
 
 rs.post("cars", "Mercedes_Benz_GT_R", {"owner": "Lisa Simpson"})
 
 print("GET: ", rs.get("cars", ""), "\n-----\n")
 # GET:  {'count': 1, 'key': ['Mercedes_Benz_GT_R'], 'result': [{'owner': 'Lisa Simpson'}]}
 
-rs.post("cars", "BMW_740li", {"owner": "Greg Onslow"}, _ADD_AUTO_INC)
-rs.post("cars", "BMW_740li", {"owner": "Sam Wise"}, _ADD_AUTO_INC)
-rs.post("cars", "BMW_740li", {"owner": "Bill Bo"}, _ADD_AUTO_INC)
+rs.post("cars", "BMW_740li", {
+        "owner": "Greg Onslow"}, Rocketstore._ADD_AUTO_INC)
+rs.post("cars", "BMW_740li", {"owner": "Sam Wise"}, Rocketstore._ADD_AUTO_INC)
+rs.post("cars", "BMW_740li", {"owner": "Bill Bo"}, Rocketstore._ADD_AUTO_INC)
 # tienen que haber un BMW_740li
 
 print("GET ALL CARS: ", rs.get("cars", "*"), "\n-----\n")
@@ -60,7 +61,7 @@
 
 
 print("Get list ordered by alphabetically descending keys: ",
-      rs.get("cars", "", _ORDER_DESC), "\n-----\n")
+      rs.get("cars", "", Rocketstore._ORDER_DESC), "\n-----\n")
 '''
 Get list ordered by alphabetically descending keys:
  {

Samples/Post/test.py renamed to Samples/post.py

@@ -1,8 +1,10 @@
-from Rocketstore import Rocketstore, _ADD_AUTO_INC
+from Rocketstore import Rocketstore
 
 rs = Rocketstore(**{"data_storage_area": "./test"})
 
 print(rs)
+print("test Constants:", rs._ADD_AUTO_INC)
+print("test Constants: ", Rocketstore._ADD_AUTO_INC)
 
 dataInput = {
     "content": "hello asfalsdfsalfaslflasl",
@@ -17,6 +19,11 @@
 
 
 out = rs.post("glOtc6EzYQTZEt0J18cU1f4Ycdz1H8WWTDVkBQTp1Gv2BWgb",
-              "memories", dataInput, _ADD_AUTO_INC)
+              "memories", dataInput, rs._ADD_AUTO_INC)
+
+print(out)
+
+out = rs.post("glOtc6EzYQTZEt0J18cU1f4Ycdz1H8WWTDVkBQTp1Gv2BWgb",
+              "memories", dataInput, Rocketstore._ADD_AUTO_INC)
 
 print(out)