tinymongo 1.0.0__py3-none-any.whl

tinymongo-1.0.0.dist-info/METADATA

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: tinymongo
+Version: 1.0.0
+Summary: A flat file drop in replacement for mongodb. Requires TinyDB
+Author-email: Stephen Chapman <schapman1974@gmail.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2016 Stephen Chapman
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        ~
+        
+Project-URL: Homepage, https://github.com/schapman1974/tinymongo
+Project-URL: Source, https://github.com/schapman1974/tinymongo
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Database
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: tinydb==3.2.1
+Requires-Dist: tinydb-serialization==1.0.4
+Requires-Dist: pymongo>=3.4.0
+Requires-Dist: pyarrow>=10.0.0
+Requires-Dist: portalocker>=2.7.0
+Provides-Extra: uv
+Requires-Dist: uvicorn>=0.23.0; extra == "uv"
+Dynamic: license-file
+
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/schapman1974/tinymongo) 
+
+
+![logo](artwork/tinymongo.png)
+
+[![Build Status](https://travis-ci.org/schapman1974/tinymongo.svg?branch=master)](https://travis-ci.org/schapman1974/tinymongo)
+
+# Purpose
+
+A simple wrapper to make a drop in replacement for mongodb out of
+[tinydb](http://tinydb.readthedocs.io/en/latest/).  This module is an
+attempt to add an interface familiar to those currently using pymongo.
+
+# Status
+
+Unit testing is currently being worked on and functionality is being
+added to the library.  Current coverage is 93%.  Current builds tested
+on Python versions 2.7 and 3.3+.
+
+# Installation
+
+The latest stable release can be installed via `pip install tinymongo`.
+
+The library is currently under rapid development and a more recent version
+may be desired.
+
+In this case, simply clone this repository, navigate
+to the root project directory, and `pip install -e .`
+
+or use `pip install -e git+https://github.com/schapman1974/tinymongo.git#egg=tinymongo`
+
+This
+is a pure python distribution and - thus - should require no external
+compilers or tools besides those contained within Python itself.
+
+# Notes for this fork
+
+- **Default storage:** this fork uses Parquet v2 files by default (via `pyarrow`) for improved I/O performance and reliability. If `pyarrow` is not available, it falls back to TinyDB's default JSON storage.
+- **Concurrency:** writes use atomic temp-file replace and optional advisory locks (`portalocker`) to reduce corruption risk under concurrent writers.
+- **Tests & CI:** a GitHub Actions workflow is included at `.github/workflows/ci.yml` to run unit tests and linters across Python versions. See `requirements-dev.txt` for dev dependencies.
+
+
+# Examples
+
+The quick start is shown below.  For a more detailed look at tinymongo,
+take a look at demo.py within the repository.
+
+```python
+    from tinymongo import TinyMongoClient
+
+    # you can include a folder name or absolute path
+    # as a parameter if not it will default to "tinydb"
+    connection = TinyMongoClient()
+
+    # either creates a new database file or accesses an existing one named `my_tiny_database`
+    db = connection.my_tiny_database
+
+    # either creates a new collection or accesses an existing one named `users`
+    collection = db.users
+
+    # insert data adds a new record returns _id
+    record_id = collection.insert_one({"username": "admin", "password": "admin", "module":"somemodule"}).inserted_id
+    user_info = collection.find_one({"_id": record_id})  # returns the record inserted
+
+    # you can also use it directly
+    db.users.insert_one({"username": "admin"})
+
+    # returns a list of all users of 'module'
+    users = db.users.find({'module': 'module'})
+
+    #update data returns True if successful and False if unsuccessful
+    upd = db.users.update_one({"username": "admin"}, {"$set": {"module":"someothermodule"}})
+
+    # Sorting users by its username DESC
+    # omitting `filter` returns all records
+    db.users.find(sort=[('username', -1)])
+
+    # Pagination of the results
+    # Getting the first 20 records
+    db.users.find(sort=[('username', -1)], skip=0, limit=20)
+    # Getting next 20 records
+    db.users.find(sort=[('username', -1)], skip=20, limit=20)
+
+    # Getting the total of records
+    db.users.count()
+
+```
+
+# Custom Storages and Serializers
+
+> HINT: Learn more about TinyDB storages and Serializers in [documentation](https://tinydb.readthedocs.io/en/latest/usage.html#storages-middlewares)
+
+## Custom Storages
+
+You have to subclass `TinyMongoClient` and provide custom storages like
+CachingMiddleware or other available TinyDB Extension.
+
+### Caching Middleware
+
+```python
+    from tinymongo import TinyMongoClient
+    from tinydb.storages import JSONStorage
+    from tinydb.middlewares import CachingMiddleware
+
+    class CachedClient(TinyMongoClient):
+        """This client has cache"""
+        @property
+        def _storage(self):
+            return CachingMiddleware(JSONStorage)
+
+    connection = CachedClient('/path/to/folder')
+```
+
+> HINT: You can nest middlewares: `FirstMiddleware(SecondMiddleware(JSONStorage))`
+
+
+## Serializers
+
+To convert your data to a format that is writable to disk TinyDB uses the Python JSON module by default. It's great when only simple data types are involved but it cannot handle more complex data types like custom classes.
+
+To support serialization of complex types you can write
+your own serializers using the `tinydb-serialization` extension.
+
+First you need to install it `pip install tinydb-serialization`
+
+## Handling datetime objects
+
+You can create a serializer for the python `datetime` using
+the following snippet:
+
+```python
+    from datetime import datetime
+    from tinydb_serialization import Serializer
+
+    class DatetimeSerializer(Serializer):
+        OBJ_CLASS = datetime
+
+        def __init__(self, format='%Y-%m-%dT%H:%M:%S', *args, **kwargs):
+            super(DatetimeSerializer, self).__init__(*args, **kwargs)
+            self._format = format
+
+        def encode(self, obj):
+            return obj.strftime(self._format)
+
+        def decode(self, s):
+            return datetime.strptime(s, self._format)
+```
+
+> NOTE: this serializer is available in `tinymongo.serializers.DateTimeSerializer`
+
+
+Now you have to subclass `TinyMongoClient` and provide customs storage.
+
+```python
+    from tinymongo import TinyMongoClient
+    from tinymongo.serializers import DateTimeSerializer
+    from tinydb_serialization import SerializationMiddleware
+
+
+    class CustomClient(TinyMongoClient):
+        @property
+        def _storage(self):
+            serialization = SerializationMiddleware()
+            serialization.register_serializer(DateTimeSerializer(), 'TinyDate')
+            # register other custom serializers
+            return serialization
+
+
+    connection = CustomClient('/path/to/folder')
+```
+
+# Flask-Admin
+
+This extension can work with Flask-Admin which gives a web based administrative
+panel to your TinyDB. Flask-Admin has features like filtering, search, web forms to
+perform CRUD (Create, Read, Update, Delete) of the TinyDB records.
+
+You can find the example of Flask-Admin with TinyMongo in [Flask-Admin Examples Repository](https://github.com/flask-admin/flask-admin/tree/master/examples/tinymongo)
+
+> NOTE: To use Flask-Admin you need to register a DateTimeSerialization as showed in the previous topic.
+
+# Contributions
+
+Contributions are welcome!  Currently, the most valuable contributions
+would be:
+
+* adding test cases
+* adding functionality consistent with pymongo
+* documentation
+* identifying bugs and issues
+
+# Future Development
+
+I will also be adding support for gridFS by storing the files somehow and indexing them in a db like mongo currently does
+
+More to come......
+
+# License
+
+MIT License

tinymongo-1.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+tinymongo/__init__.py,sha256=3hfekaT5b_pqhMaKWooKzQB4xWE-OMdJAv8991lcVGk,107
+tinymongo/errors.py,sha256=FQU1tKhM7ZGIzZ6KPv_tDUl1srzXploQkJ1S79crV2c,1664
+tinymongo/parquet_storage.py,sha256=Bxn3_TPCpKmZFljaDrsggH9tbzJtfYB5fij546OxgR0,9044
+tinymongo/results.py,sha256=HcMaO4HskP_0gXkvLcfPSmKdABT2_PFpWNTvzmo9xfg,3409
+tinymongo/serializers.py,sha256=uDjIKvF1oBkhL2EDq6e8WbHSqOAYOuQ2gRQvP_ltf0w,646
+tinymongo/storage_backends.py,sha256=PrCP9WzzBUhCVpbCiSxfywzcDSBghrA9MTpqYnyeXz0,4903
+tinymongo/tinymongo.py,sha256=97Zu9MxUdsG1xG3jc-t2HYfwcJmjzRLorg_yUP60qDY,34132
+tinymongo-1.0.0.dist-info/licenses/LICENSE.txt,sha256=YPo2oONk31kuLbBq2CaSQsCCkXAxq4KRutYN2vv3KP0,1084
+tinymongo-1.0.0.dist-info/METADATA,sha256=ulUg4dHqigzWBIf25GqFBJqUCF1KPIkSWIRo65H3BO8,8880
+tinymongo-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+tinymongo-1.0.0.dist-info/top_level.txt,sha256=OeWR-1XMYO15aoVd9cgcYrUbsSuE-6MfokUHbtbgbp4,10
+tinymongo-1.0.0.dist-info/RECORD,,

tinymongo-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tinymongo-1.0.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stephen Chapman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+~

tinymongo-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tinymongo