tinyflux 0.4.2__tar.gz → 1.0.1__tar.gz

{tinyflux-0.4.2/tinyflux.egg-info → tinyflux-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tinyflux
-Version: 0.4.2
+Version: 1.0.1
 Summary: The Tiny Time-Series Database Optimized for Your Happiness
 Home-page: https://github.com/citrusvanilla/tinyflux
 Author: Justin Fung
@@ -17,19 +17,20 @@ Classifier: Topic :: Database
 Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: Topic :: Utilities
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Operating System :: OS Independent
 Classifier: Typing :: Typed
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Dynamic: license-file
 
 .. image:: https://github.com/citrusvanilla/tinyflux/blob/master/artwork/tinyfluxdb-light.png?raw=true#gh-dark-mode-only
     :width: 500px
@@ -37,11 +38,11 @@ License-File: LICENSE
 .. image:: https://github.com/citrusvanilla/tinyflux/blob/master/artwork/tinyfluxdb-dark.png?raw=true#gh-light-mode-only
     :width: 500px
 
-TinyFlux is the tiny time series database optimized for your happiness :)
+TinyFlux is the tiny time series database optimized for your happiness 😎
 
-TinyFlux is a time series version of `TinyDB <https://tinydb.readthedocs.io/en/latest/index.html>`__ that is also written in Python and has no external dependencies.  It's a great companion for small analytics workflows and apps, as well as at-home IOT data stores.  TinyFlux has 100% test coverage, over 50,000 downloads, and no open issues.
+TinyFlux is the time series version of `TinyDB <https://tinydb.readthedocs.io/en/latest/index.html>`__ that is written in Python and has no external dependencies.  It's a great companion for small analytics workflows and apps, as well as at-home IOT data stores.  TinyFlux has 100% test coverage, over 120,000 downloads, and no open issues.
 
-|Build Status| |Coverage| |Version| |Downloads|
+|Docs| |Version| |Downloads| |Coverage| |Build Status|
 
 
 Quick Links
@@ -57,7 +58,7 @@ Quick Links
 Installation
 ************
 
-TinyFlux is hosted at `PyPI <https://pypi.org/project/tinyflux/>`__ and is easily downloadable with ``pip``. TinyFlux has been tested with Python 3.7 - 3.12 and PyPy-3.9 on Linux and Windows platforms.
+TinyFlux is hosted at `PyPI <https://pypi.org/project/tinyflux/>`__ and is easily downloadable with ``pip``. TinyFlux has been tested with Python 3.8 - 3.13 and PyPy-3.9 on Linux and Windows platforms.
 
 .. code-block:: bash
 
@@ -69,19 +70,19 @@ Introduction
 
 TinyFlux is:
 
-- **time-centric:** Python datetime objects are first-class citizens and queries are optimized for time, above all else.
+- **optimized for your happiness:** TinyFlux is designed to be simple and fun to use by providing a clean API that can be learned in about 90 seconds.
 
-- **optimized for your happiness:** TinyFlux is designed to be simple and
-  fun to use by providing a simple and clean API that can be learned in 5 minutes.
+- **time-centric:** Python datetime objects are first-class citizens, and both the storage and queries are optimized for time above all else.
 
-- **tiny:** The current source code has 4,000 lines of code (with about 50%
-  documentation) and 4,000 lines of tests.  TinyFlux is about 150kb, unzipped.
+- **human-friendly:** The primary datastore is a CSV, making your database human-readable from the very first write. No need to use SQL to investigate your data, just open the DB file in any tabular-friendly application.
 
-- **written in pure Python:** TinyFlux needs neither an external server nor any dependencies.
+- **pure Python:** TinyFlux needs neither an external server nor any dependencies.
 
-- **works on Python 3.7+ and PyPy-3.9:** TinyFlux works on all modern versions of Python and PyPy.
+- **tiny:** TinyFlux is about 150kb, unzipped. The current source code has 4,000 lines of code (with about 50% documentation) and 4,000 lines of tests.  
 
-- **100% test coverage:** No explanation needed.
+- **developed for modern Python:** TinyFlux works on all modern versions of Python (3.8 - 3.13) and PyPy (3.9).
+
+- **100% covered by tests:** No explanation needed.
 
 To get started, head over to the `TinyFlux docs <https://tinyflux.readthedocs.io/>`__.  Examples can be found in the `examples directory <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__.  You can also discuss topics related to TinyFlux including general development, extensions, or showcase your TinyFlux-based projects on the `GitHub discussion forum <https://github.com/citrusvanilla/tinyflux/discussions>`__.
 
@@ -135,7 +136,7 @@ Querying TinyFlux
 Full Example Notebooks and Workflows
 ************************************
 
-The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__ directory of this repository contains three common uses cases for TinyFlux and the associated boilerplate to get you started:
+The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__ directory of this repository contains four common uses cases for TinyFlux and the associated boilerplate to get you started:
 
 1. `Loading a TinyFlux DB from a CSV <https://github.com/citrusvanilla/tinyflux/blob/master/examples/1_initializing_and_loading_new_db.ipynb>`__
 2. `Local Analytics Workflow with a TinyFlux Database <https://github.com/citrusvanilla/tinyflux/blob/master/examples/2_analytics_workflow.ipynb>`__
@@ -151,16 +152,16 @@ Checkout some tips for working with TinyFlux `here <https://tinyflux.readthedocs
 TinyFlux Across the Internet
 ****************************
 
-Articles, tutorials, and other instances of TinyFlux:
+Articles, tutorials, and other instances of TinyFlux in the wild:
 
 - `"Introducing TinyFlux: The Tiny Time Series Database for Python-based IoT & Analytics Applications" <https://citrusvanilla.medium.com/introducing-tinyflux-the-tiny-time-series-database-for-python-based-iot-analytics-applications-c3ef3c3bedf>`__: A Medium.com article announcing the release of TinyFlux
 - `"Storing Time Series Data in Python Using TinyFluxDB" <http://www.steves-internet-guide.com/storing-time-series-data-python-using-tinyflux-db/>`__: A tutorial from `Steve's Internet Guide <http://www.steves-internet-guide.com/>`__, a portal for learning MQTT and IoT development for Python
-
+- `"KaiCode 2024 Shortlist" <https://www.kaicode.org/2024.html>`__: TinyFlux came in 10th place out of 412 entrants in the 7th edition of this open-source festival, a festival dedicated to recognizing projects with high-quality open-source principles.
 
 Contributing
 ************
 
-New ideas, new developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
+New ideas, developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
 
 1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`__ and the `Contributing Tooling and Conventions <https://tinyflux.readthedocs.io/en/latest/contributing-tooling.html>`__ section of the documentation.
 2. Check GitHub for `existing open issues <https://github.com/citrusvanilla/tinyflux/issues>`__, `open a new issue <https://github.com/citrusvanilla/tinyflux/issues/new>`__ or `start a new discussion <https://github.com/citrusvanilla/tinyflux/discussions/new>`__.
@@ -168,11 +169,13 @@ New ideas, new developer tools, improvements, and bugfixes are always welcome.
 4. Write unit tests, ensure the code is 100% covered, update documentation where necessary, and format and style the code correctly.
 5. Send a pull request.
 
+.. |Docs| image:: https://img.shields.io/readthedocs/docs
+   :target: https://tinyflux.readthedocs.io/en/latest/
 .. |Build Status| image:: https://github.com/citrusvanilla/tinyflux/actions/workflows/build.yml/badge.svg
    :target: https://github.com/citrusvanilla/tinyflux/actions
 .. |Coverage| image:: https://codecov.io/gh/citrusvanilla/tinyflux/branch/master/graph/badge.svg?token=IEGQ4E57VA
    :target: https://app.codecov.io/gh/citrusvanilla/tinyflux
 .. |Version| image:: http://img.shields.io/pypi/v/tinyflux.svg
    :target: https://pypi.python.org/pypi/tinyflux/
-.. |Downloads| image:: https://img.shields.io/pypi/dm/tinyflux.svg
+.. |Downloads| image:: https://img.shields.io/pepy/dt/tinyflux
    :target: https://pypi.python.org/pypi/tinyflux/

{tinyflux-0.4.2 → tinyflux-1.0.1}/README.rst

@@ -4,11 +4,11 @@
 .. image:: https://github.com/citrusvanilla/tinyflux/blob/master/artwork/tinyfluxdb-dark.png?raw=true#gh-light-mode-only
     :width: 500px
 
-TinyFlux is the tiny time series database optimized for your happiness :)
+TinyFlux is the tiny time series database optimized for your happiness 😎
 
-TinyFlux is a time series version of `TinyDB <https://tinydb.readthedocs.io/en/latest/index.html>`__ that is also written in Python and has no external dependencies.  It's a great companion for small analytics workflows and apps, as well as at-home IOT data stores.  TinyFlux has 100% test coverage, over 50,000 downloads, and no open issues.
+TinyFlux is the time series version of `TinyDB <https://tinydb.readthedocs.io/en/latest/index.html>`__ that is written in Python and has no external dependencies.  It's a great companion for small analytics workflows and apps, as well as at-home IOT data stores.  TinyFlux has 100% test coverage, over 120,000 downloads, and no open issues.
 
-|Build Status| |Coverage| |Version| |Downloads|
+|Docs| |Version| |Downloads| |Coverage| |Build Status|
 
 
 Quick Links
@@ -24,7 +24,7 @@ Quick Links
 Installation
 ************
 
-TinyFlux is hosted at `PyPI <https://pypi.org/project/tinyflux/>`__ and is easily downloadable with ``pip``. TinyFlux has been tested with Python 3.7 - 3.12 and PyPy-3.9 on Linux and Windows platforms.
+TinyFlux is hosted at `PyPI <https://pypi.org/project/tinyflux/>`__ and is easily downloadable with ``pip``. TinyFlux has been tested with Python 3.8 - 3.13 and PyPy-3.9 on Linux and Windows platforms.
 
 .. code-block:: bash
 
@@ -36,19 +36,19 @@ Introduction
 
 TinyFlux is:
 
-- **time-centric:** Python datetime objects are first-class citizens and queries are optimized for time, above all else.
+- **optimized for your happiness:** TinyFlux is designed to be simple and fun to use by providing a clean API that can be learned in about 90 seconds.
 
-- **optimized for your happiness:** TinyFlux is designed to be simple and
-  fun to use by providing a simple and clean API that can be learned in 5 minutes.
+- **time-centric:** Python datetime objects are first-class citizens, and both the storage and queries are optimized for time above all else.
 
-- **tiny:** The current source code has 4,000 lines of code (with about 50%
-  documentation) and 4,000 lines of tests.  TinyFlux is about 150kb, unzipped.
+- **human-friendly:** The primary datastore is a CSV, making your database human-readable from the very first write. No need to use SQL to investigate your data, just open the DB file in any tabular-friendly application.
 
-- **written in pure Python:** TinyFlux needs neither an external server nor any dependencies.
+- **pure Python:** TinyFlux needs neither an external server nor any dependencies.
 
-- **works on Python 3.7+ and PyPy-3.9:** TinyFlux works on all modern versions of Python and PyPy.
+- **tiny:** TinyFlux is about 150kb, unzipped. The current source code has 4,000 lines of code (with about 50% documentation) and 4,000 lines of tests.  
 
-- **100% test coverage:** No explanation needed.
+- **developed for modern Python:** TinyFlux works on all modern versions of Python (3.8 - 3.13) and PyPy (3.9).
+
+- **100% covered by tests:** No explanation needed.
 
 To get started, head over to the `TinyFlux docs <https://tinyflux.readthedocs.io/>`__.  Examples can be found in the `examples directory <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__.  You can also discuss topics related to TinyFlux including general development, extensions, or showcase your TinyFlux-based projects on the `GitHub discussion forum <https://github.com/citrusvanilla/tinyflux/discussions>`__.
 
@@ -102,7 +102,7 @@ Querying TinyFlux
 Full Example Notebooks and Workflows
 ************************************
 
-The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__ directory of this repository contains three common uses cases for TinyFlux and the associated boilerplate to get you started:
+The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__ directory of this repository contains four common uses cases for TinyFlux and the associated boilerplate to get you started:
 
 1. `Loading a TinyFlux DB from a CSV <https://github.com/citrusvanilla/tinyflux/blob/master/examples/1_initializing_and_loading_new_db.ipynb>`__
 2. `Local Analytics Workflow with a TinyFlux Database <https://github.com/citrusvanilla/tinyflux/blob/master/examples/2_analytics_workflow.ipynb>`__
@@ -118,16 +118,16 @@ Checkout some tips for working with TinyFlux `here <https://tinyflux.readthedocs
 TinyFlux Across the Internet
 ****************************
 
-Articles, tutorials, and other instances of TinyFlux:
+Articles, tutorials, and other instances of TinyFlux in the wild:
 
 - `"Introducing TinyFlux: The Tiny Time Series Database for Python-based IoT & Analytics Applications" <https://citrusvanilla.medium.com/introducing-tinyflux-the-tiny-time-series-database-for-python-based-iot-analytics-applications-c3ef3c3bedf>`__: A Medium.com article announcing the release of TinyFlux
 - `"Storing Time Series Data in Python Using TinyFluxDB" <http://www.steves-internet-guide.com/storing-time-series-data-python-using-tinyflux-db/>`__: A tutorial from `Steve's Internet Guide <http://www.steves-internet-guide.com/>`__, a portal for learning MQTT and IoT development for Python
-
+- `"KaiCode 2024 Shortlist" <https://www.kaicode.org/2024.html>`__: TinyFlux came in 10th place out of 412 entrants in the 7th edition of this open-source festival, a festival dedicated to recognizing projects with high-quality open-source principles.
 
 Contributing
 ************
 
-New ideas, new developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
+New ideas, developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
 
 1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`__ and the `Contributing Tooling and Conventions <https://tinyflux.readthedocs.io/en/latest/contributing-tooling.html>`__ section of the documentation.
 2. Check GitHub for `existing open issues <https://github.com/citrusvanilla/tinyflux/issues>`__, `open a new issue <https://github.com/citrusvanilla/tinyflux/issues/new>`__ or `start a new discussion <https://github.com/citrusvanilla/tinyflux/discussions/new>`__.
@@ -135,11 +135,13 @@ New ideas, new developer tools, improvements, and bugfixes are always welcome.
 4. Write unit tests, ensure the code is 100% covered, update documentation where necessary, and format and style the code correctly.
 5. Send a pull request.
 
+.. |Docs| image:: https://img.shields.io/readthedocs/docs
+   :target: https://tinyflux.readthedocs.io/en/latest/
 .. |Build Status| image:: https://github.com/citrusvanilla/tinyflux/actions/workflows/build.yml/badge.svg
    :target: https://github.com/citrusvanilla/tinyflux/actions
 .. |Coverage| image:: https://codecov.io/gh/citrusvanilla/tinyflux/branch/master/graph/badge.svg?token=IEGQ4E57VA
    :target: https://app.codecov.io/gh/citrusvanilla/tinyflux
 .. |Version| image:: http://img.shields.io/pypi/v/tinyflux.svg
    :target: https://pypi.python.org/pypi/tinyflux/
-.. |Downloads| image:: https://img.shields.io/pypi/dm/tinyflux.svg
+.. |Downloads| image:: https://img.shields.io/pepy/dt/tinyflux
    :target: https://pypi.python.org/pypi/tinyflux/

{tinyflux-0.4.2 → tinyflux-1.0.1}/setup.cfg

@@ -29,12 +29,12 @@ classifiers =
 	Topic :: Database :: Database Engines/Servers
 	Topic :: Utilities
 	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.7
 	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
 	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: 3.13
 	Programming Language :: Python :: Implementation :: CPython
 	Programming Language :: Python :: Implementation :: PyPy
 	Operating System :: OS Independent
@@ -42,7 +42,7 @@ classifiers =
 
 [options]
 packages = tinyflux
-python_requires = >=3.7
+python_requires = >=3.8
 
 [options.package_data]
 tinyflux = py.typed

{tinyflux-0.4.2 → tinyflux-1.0.1}/tinyflux/database.py

@@ -2,7 +2,6 @@
 
 import copy
 from datetime import datetime, timezone
-from functools import wraps
 from typing import (
     Any,
     Callable,
@@ -16,6 +15,7 @@ from typing import (
     Union,
 )
 
+from .decorators import read_op, write_op, temp_storage_op, append_op
 from .index import Index
 from .measurement import Measurement
 from .point import (
@@ -36,79 +36,6 @@ from .queries import (
 from .storages import CSVStorage, Storage
 
 
-def append_op(method: Callable[..., Any]) -> Callable[..., Any]:
-    """Decorate an append operation with assertion.
-
-    Ensures storage can be appended to before doing anything.
-    """
-
-    @wraps(method)
-    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
-        """Decorate."""
-        assert self._storage.can_append
-        return method(self, *args, **kwargs)
-
-    return op
-
-
-def read_op(method: Callable[..., Any]) -> Callable[..., Any]:
-    """Decorate a read operation with assertion.
-
-    Ensures storage can be read from before doing anything.
-    """
-
-    @wraps(method)
-    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
-        """Decorate."""
-        assert self._storage.can_read
-
-        if self._auto_index and not self._index.valid:
-            self.reindex()
-
-        return method(self, *args, **kwargs)
-
-    return op
-
-
-def temp_storage_op(method: Callable[..., Any]) -> Callable[..., Any]:
-    """Decorate a db operation that requires auxiliary storage.
-
-    Initializes temporary storage, invokes method, and cleans-up storage after
-    op has run.
-    """
-
-    @wraps(method)
-    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
-        """Decorate."""
-        # Init temp storage in the storage class.
-        self._storage._init_temp_storage()
-
-        # Invoke op.
-        rst = method(self, *args, **kwargs)
-
-        # Clean-up temp storage.
-        self._storage._cleanup_temp_storage()
-
-        return rst
-
-    return op
-
-
-def write_op(method: Callable[..., Any]) -> Callable[..., Any]:
-    """Decorate a write operation with assertion.
-
-    Ensures storage can be written to before doing anything.
-    """
-
-    @wraps(method)
-    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
-        """Decorate."""
-        assert self._storage.can_write
-        return method(self, *args, **kwargs)
-
-    return op
-
-
 class TinyFlux:
     """The TinyFlux class containing the interface for the TinyFlux package.
 

tinyflux-1.0.1/tinyflux/decorators.py

@@ -0,0 +1,94 @@
+"""
+This module contains decorators for various operations related to \
+storage management.
+
+The decorators ensure certain preconditions are met before executing methods,
+such as checking if the storage is appendable, readable, or writable. They also
+handle temporary storage initialization and cleanup when required.
+
+Decorators included:
+- `append_op`: Ensures storage can be appended to before executing the method.
+- `read_op`: Ensures storage can be read from, with optional reindexing.
+- `temp_storage_op`: Handles temporary storage initialization and cleanup for
+  operations.
+- `write_op`: Ensures storage can be written to before executing the method.
+"""
+
+from functools import wraps
+from typing import (
+    Any,
+    Callable,
+)
+
+
+def append_op(method: Callable[..., Any]) -> Callable[..., Any]:
+    """Decorate an append operation with assertion.
+
+    Ensures storage can be appended to before doing anything.
+    """
+
+    @wraps(method)
+    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
+        """Decorate."""
+        assert self._storage.can_append
+        return method(self, *args, **kwargs)
+
+    return op
+
+
+def read_op(method: Callable[..., Any]) -> Callable[..., Any]:
+    """Decorate a read operation with assertion.
+
+    Ensures storage can be read from before doing anything.
+    """
+
+    @wraps(method)
+    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
+        """Decorate."""
+        assert self._storage.can_read
+
+        if self._auto_index and not self._index.valid:
+            self.reindex()
+
+        return method(self, *args, **kwargs)
+
+    return op
+
+
+def temp_storage_op(method: Callable[..., Any]) -> Callable[..., Any]:
+    """Decorate a db operation that requires auxiliary storage.
+
+    Initializes temporary storage, invokes method, and cleans-up storage after
+    op has run.
+    """
+
+    @wraps(method)
+    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
+        """Decorate."""
+        # Init temp storage in the storage class.
+        self._storage._init_temp_storage()
+
+        # Invoke op.
+        rst = method(self, *args, **kwargs)
+
+        # Clean-up temp storage.
+        self._storage._cleanup_temp_storage()
+
+        return rst
+
+    return op
+
+
+def write_op(method: Callable[..., Any]) -> Callable[..., Any]:
+    """Decorate a write operation with assertion.
+
+    Ensures storage can be written to before doing anything.
+    """
+
+    @wraps(method)
+    def op(self: Any, *args: Any, **kwargs: Any) -> Any:
+        """Decorate."""
+        assert self._storage.can_write
+        return method(self, *args, **kwargs)
+
+    return op

tinyflux-1.0.1/tinyflux/version.py

@@ -0,0 +1,3 @@
+"""Version."""
+
+__version__ = "1.0.1"  # pragma: no cover

{tinyflux-0.4.2 → tinyflux-1.0.1/tinyflux.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tinyflux
-Version: 0.4.2
+Version: 1.0.1
 Summary: The Tiny Time-Series Database Optimized for Your Happiness
 Home-page: https://github.com/citrusvanilla/tinyflux
 Author: Justin Fung
@@ -17,19 +17,20 @@ Classifier: Topic :: Database
 Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: Topic :: Utilities
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Operating System :: OS Independent
 Classifier: Typing :: Typed
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Dynamic: license-file
 
 .. image:: https://github.com/citrusvanilla/tinyflux/blob/master/artwork/tinyfluxdb-light.png?raw=true#gh-dark-mode-only
     :width: 500px
@@ -37,11 +38,11 @@ License-File: LICENSE
 .. image:: https://github.com/citrusvanilla/tinyflux/blob/master/artwork/tinyfluxdb-dark.png?raw=true#gh-light-mode-only
     :width: 500px
 
-TinyFlux is the tiny time series database optimized for your happiness :)
+TinyFlux is the tiny time series database optimized for your happiness 😎
 
-TinyFlux is a time series version of `TinyDB <https://tinydb.readthedocs.io/en/latest/index.html>`__ that is also written in Python and has no external dependencies.  It's a great companion for small analytics workflows and apps, as well as at-home IOT data stores.  TinyFlux has 100% test coverage, over 50,000 downloads, and no open issues.
+TinyFlux is the time series version of `TinyDB <https://tinydb.readthedocs.io/en/latest/index.html>`__ that is written in Python and has no external dependencies.  It's a great companion for small analytics workflows and apps, as well as at-home IOT data stores.  TinyFlux has 100% test coverage, over 120,000 downloads, and no open issues.
 
-|Build Status| |Coverage| |Version| |Downloads|
+|Docs| |Version| |Downloads| |Coverage| |Build Status|
 
 
 Quick Links
@@ -57,7 +58,7 @@ Quick Links
 Installation
 ************
 
-TinyFlux is hosted at `PyPI <https://pypi.org/project/tinyflux/>`__ and is easily downloadable with ``pip``. TinyFlux has been tested with Python 3.7 - 3.12 and PyPy-3.9 on Linux and Windows platforms.
+TinyFlux is hosted at `PyPI <https://pypi.org/project/tinyflux/>`__ and is easily downloadable with ``pip``. TinyFlux has been tested with Python 3.8 - 3.13 and PyPy-3.9 on Linux and Windows platforms.
 
 .. code-block:: bash
 
@@ -69,19 +70,19 @@ Introduction
 
 TinyFlux is:
 
-- **time-centric:** Python datetime objects are first-class citizens and queries are optimized for time, above all else.
+- **optimized for your happiness:** TinyFlux is designed to be simple and fun to use by providing a clean API that can be learned in about 90 seconds.
 
-- **optimized for your happiness:** TinyFlux is designed to be simple and
-  fun to use by providing a simple and clean API that can be learned in 5 minutes.
+- **time-centric:** Python datetime objects are first-class citizens, and both the storage and queries are optimized for time above all else.
 
-- **tiny:** The current source code has 4,000 lines of code (with about 50%
-  documentation) and 4,000 lines of tests.  TinyFlux is about 150kb, unzipped.
+- **human-friendly:** The primary datastore is a CSV, making your database human-readable from the very first write. No need to use SQL to investigate your data, just open the DB file in any tabular-friendly application.
 
-- **written in pure Python:** TinyFlux needs neither an external server nor any dependencies.
+- **pure Python:** TinyFlux needs neither an external server nor any dependencies.
 
-- **works on Python 3.7+ and PyPy-3.9:** TinyFlux works on all modern versions of Python and PyPy.
+- **tiny:** TinyFlux is about 150kb, unzipped. The current source code has 4,000 lines of code (with about 50% documentation) and 4,000 lines of tests.  
 
-- **100% test coverage:** No explanation needed.
+- **developed for modern Python:** TinyFlux works on all modern versions of Python (3.8 - 3.13) and PyPy (3.9).
+
+- **100% covered by tests:** No explanation needed.
 
 To get started, head over to the `TinyFlux docs <https://tinyflux.readthedocs.io/>`__.  Examples can be found in the `examples directory <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__.  You can also discuss topics related to TinyFlux including general development, extensions, or showcase your TinyFlux-based projects on the `GitHub discussion forum <https://github.com/citrusvanilla/tinyflux/discussions>`__.
 
@@ -135,7 +136,7 @@ Querying TinyFlux
 Full Example Notebooks and Workflows
 ************************************
 
-The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__ directory of this repository contains three common uses cases for TinyFlux and the associated boilerplate to get you started:
+The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`__ directory of this repository contains four common uses cases for TinyFlux and the associated boilerplate to get you started:
 
 1. `Loading a TinyFlux DB from a CSV <https://github.com/citrusvanilla/tinyflux/blob/master/examples/1_initializing_and_loading_new_db.ipynb>`__
 2. `Local Analytics Workflow with a TinyFlux Database <https://github.com/citrusvanilla/tinyflux/blob/master/examples/2_analytics_workflow.ipynb>`__
@@ -151,16 +152,16 @@ Checkout some tips for working with TinyFlux `here <https://tinyflux.readthedocs
 TinyFlux Across the Internet
 ****************************
 
-Articles, tutorials, and other instances of TinyFlux:
+Articles, tutorials, and other instances of TinyFlux in the wild:
 
 - `"Introducing TinyFlux: The Tiny Time Series Database for Python-based IoT & Analytics Applications" <https://citrusvanilla.medium.com/introducing-tinyflux-the-tiny-time-series-database-for-python-based-iot-analytics-applications-c3ef3c3bedf>`__: A Medium.com article announcing the release of TinyFlux
 - `"Storing Time Series Data in Python Using TinyFluxDB" <http://www.steves-internet-guide.com/storing-time-series-data-python-using-tinyflux-db/>`__: A tutorial from `Steve's Internet Guide <http://www.steves-internet-guide.com/>`__, a portal for learning MQTT and IoT development for Python
-
+- `"KaiCode 2024 Shortlist" <https://www.kaicode.org/2024.html>`__: TinyFlux came in 10th place out of 412 entrants in the 7th edition of this open-source festival, a festival dedicated to recognizing projects with high-quality open-source principles.
 
 Contributing
 ************
 
-New ideas, new developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
+New ideas, developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
 
 1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`__ and the `Contributing Tooling and Conventions <https://tinyflux.readthedocs.io/en/latest/contributing-tooling.html>`__ section of the documentation.
 2. Check GitHub for `existing open issues <https://github.com/citrusvanilla/tinyflux/issues>`__, `open a new issue <https://github.com/citrusvanilla/tinyflux/issues/new>`__ or `start a new discussion <https://github.com/citrusvanilla/tinyflux/discussions/new>`__.
@@ -168,11 +169,13 @@ New ideas, new developer tools, improvements, and bugfixes are always welcome.
 4. Write unit tests, ensure the code is 100% covered, update documentation where necessary, and format and style the code correctly.
 5. Send a pull request.
 
+.. |Docs| image:: https://img.shields.io/readthedocs/docs
+   :target: https://tinyflux.readthedocs.io/en/latest/
 .. |Build Status| image:: https://github.com/citrusvanilla/tinyflux/actions/workflows/build.yml/badge.svg
    :target: https://github.com/citrusvanilla/tinyflux/actions
 .. |Coverage| image:: https://codecov.io/gh/citrusvanilla/tinyflux/branch/master/graph/badge.svg?token=IEGQ4E57VA
    :target: https://app.codecov.io/gh/citrusvanilla/tinyflux
 .. |Version| image:: http://img.shields.io/pypi/v/tinyflux.svg
    :target: https://pypi.python.org/pypi/tinyflux/
-.. |Downloads| image:: https://img.shields.io/pypi/dm/tinyflux.svg
+.. |Downloads| image:: https://img.shields.io/pepy/dt/tinyflux
    :target: https://pypi.python.org/pypi/tinyflux/

{tinyflux-0.4.2 → tinyflux-1.0.1}/tinyflux.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ tests/test_tinyflux.py
 tests/test_utils.py
 tinyflux/__init__.py
 tinyflux/database.py
+tinyflux/decorators.py
 tinyflux/index.py
 tinyflux/measurement.py
 tinyflux/point.py

tinyflux-0.4.2/tinyflux/version.py

@@ -1,3 +0,0 @@
-"""Version."""
-
-__version__ = "0.4.2"  # pragma: no cover