tinyflux 0.4.0__tar.gz → 0.4.2__tar.gz

tinyflux-0.4.2/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+recursive-include tests *.py

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinyflux
-Version: 0.4.0
+Version: 0.4.2
 Summary: The Tiny Time-Series Database Optimized for Your Happiness
 Home-page: https://github.com/citrusvanilla/tinyflux
 Author: Justin Fung
@@ -22,6 +22,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 :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Operating System :: OS Independent
@@ -36,8 +37,13 @@ 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 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.
+
 |Build Status| |Coverage| |Version| |Downloads|
 
+
 Quick Links
 ***********
 
@@ -48,49 +54,19 @@ Quick Links
 - `Contributing`_
 
 
-Recent Updates
-**************
-
-v0.4.0 - March 27, 2023
-=======================
-
-* Tags and Fields can be removed from individual points. See `the documentation <https://tinyflux.readthedocs.io/en/latest/updating-data.html#removing-tags-and-fields-with-update>`__ for more (resolves issue #27).
-
-v0.3.1 - March 27, 2023
-=======================
-
-* Fixed bug that allowed user to delete key/field tags with `.update()` and `.update_all()` (resolves issue #36).
-
-v0.3.0 - March 23, 2023
-=======================
-
-* Tag and field keys can be compacted when using CSVStorage, saving potentially many bytes per Point (resolves issue #32).
-* Fixed bug that causes tag values of `""` to be serialized as `"_none"` (resolves issue #33).
-
-See the `Changelog <https://tinyflux.readthedocs.io/en/latest/changelog.html>`__ for more.
-
-
 Installation
 ************
 
-.. code-block:: bash
-
-    $ pip install tinyflux
-
-Or, download this repository, ``cd`` into it, and:
+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.
 
 .. code-block:: bash
 
-    $ pip install .
+    $ pip install tinyflux
 
 
 Introduction
 ************
 
-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 is:
 
 - **time-centric:** Python datetime objects are first-class citizens and queries are optimized for time, above all else.
@@ -109,10 +85,6 @@ TinyFlux is:
 
 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>`__.
 
-Supported Python Versions
-*************************
-
-TinyFlux has been tested with Python 3.7 - 3.11 and PyPy-3.9 on Linux and Windows platforms.
 
 Example Code Snippets
 *********************
@@ -168,6 +140,7 @@ The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`_
 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>`__
 3. `TinyFlux as a MQTT Datastore for IoT Devices <https://github.com/citrusvanilla/tinyflux/blob/master/examples/3_iot_datastore_with_mqtt.py>`__
+4. `TinyFlux at the Edge (with Backup Strategy) <https://github.com/citrusvanilla/tinyflux/blob/master/examples/4_backing_up_tinyflux_at_the_edge.py>`__
 
 Tips
 ****
@@ -196,8 +169,9 @@ New ideas, new developer tools, improvements, and bugfixes are always welcome.
 5. Send a pull request.
 
 .. |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
+   :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

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

@@ -4,8 +4,13 @@
 .. 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 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.
+
 |Build Status| |Coverage| |Version| |Downloads|
 
+
 Quick Links
 ***********
 
@@ -16,49 +21,19 @@ Quick Links
 - `Contributing`_
 
 
-Recent Updates
-**************
-
-v0.4.0 - March 27, 2023
-=======================
-
-* Tags and Fields can be removed from individual points. See `the documentation <https://tinyflux.readthedocs.io/en/latest/updating-data.html#removing-tags-and-fields-with-update>`__ for more (resolves issue #27).
-
-v0.3.1 - March 27, 2023
-=======================
-
-* Fixed bug that allowed user to delete key/field tags with `.update()` and `.update_all()` (resolves issue #36).
-
-v0.3.0 - March 23, 2023
-=======================
-
-* Tag and field keys can be compacted when using CSVStorage, saving potentially many bytes per Point (resolves issue #32).
-* Fixed bug that causes tag values of `""` to be serialized as `"_none"` (resolves issue #33).
-
-See the `Changelog <https://tinyflux.readthedocs.io/en/latest/changelog.html>`__ for more.
-
-
 Installation
 ************
 
-.. code-block:: bash
-
-    $ pip install tinyflux
-
-Or, download this repository, ``cd`` into it, and:
+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.
 
 .. code-block:: bash
 
-    $ pip install .
+    $ pip install tinyflux
 
 
 Introduction
 ************
 
-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 is:
 
 - **time-centric:** Python datetime objects are first-class citizens and queries are optimized for time, above all else.
@@ -77,10 +52,6 @@ TinyFlux is:
 
 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>`__.
 
-Supported Python Versions
-*************************
-
-TinyFlux has been tested with Python 3.7 - 3.11 and PyPy-3.9 on Linux and Windows platforms.
 
 Example Code Snippets
 *********************
@@ -136,6 +107,7 @@ The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`_
 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>`__
 3. `TinyFlux as a MQTT Datastore for IoT Devices <https://github.com/citrusvanilla/tinyflux/blob/master/examples/3_iot_datastore_with_mqtt.py>`__
+4. `TinyFlux at the Edge (with Backup Strategy) <https://github.com/citrusvanilla/tinyflux/blob/master/examples/4_backing_up_tinyflux_at_the_edge.py>`__
 
 Tips
 ****
@@ -164,8 +136,9 @@ New ideas, new developer tools, improvements, and bugfixes are always welcome.
 5. Send a pull request.
 
 .. |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
+   :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

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

@@ -8,7 +8,7 @@ extend-ignore = E203
 
 [metadata]
 name = tinyflux
-version = file: version.txt
+version = attr: tinyflux.version.__version__
 author = Justin Fung
 author_email = justincaseyfung@gmail.com
 description = The Tiny Time-Series Database Optimized for Your Happiness
@@ -34,6 +34,7 @@ classifiers =
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
 	Programming Language :: Python :: Implementation :: CPython
 	Programming Language :: Python :: Implementation :: PyPy
 	Operating System :: OS Independent

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/conftest.py

@@ -1,4 +1,5 @@
 """PyTest configuration and test fixtures."""
+
 import pytest
 
 from tinyflux.storages import CSVStorage, MemoryStorage

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/test_index.py

@@ -1,4 +1,5 @@
 """Tests for tinyflux.index module."""
+
 from datetime import datetime, timezone, timedelta
 import pytest
 
@@ -118,7 +119,7 @@ def test_insert_time_method():
     assert index._timestamps == [t1.timestamp(), t2.timestamp()]
 
 
-def test_index_measuments_method():
+def test_index_measurements_method():
     """Test _insert_measurements helper of Index."""
     index = Index()
 
@@ -381,7 +382,7 @@ def test_search_compound_query_not():
     rst = index.search(~fiel_q)
     assert rst.items == {0, 1}
 
-    # Compount NOT FieldQuery.
+    # Compound NOT FieldQuery.
     rst = index.search(~fiel_q & tags_q)
     assert rst.items == {0}
 

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/test_measurement.py

@@ -2,6 +2,7 @@
 
 Tests are generally organized by Measurement class method.
 """
+
 from datetime import datetime, timezone, timedelta
 import re
 from typing import Generator
@@ -43,7 +44,7 @@ def test_iter():
 
 
 def test_len():
-    """Test __len__ of Measuremnt."""
+    """Test __len__ of Measurement."""
     db = TinyFlux(storage=MemoryStorage)
     m = db.measurement("a")
     assert len(m) == 0
@@ -468,7 +469,7 @@ def test_insert():
     assert len(m1) == 1
     assert len(m2) == 0
 
-    # Insert in-order, into a different measurment.
+    # Insert in-order, into a different measurement.
     assert m2.insert(p2) == 1
     assert db.index.valid and not db.index.empty
     assert len(db.index) == 2

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/test_point.py

@@ -1,4 +1,5 @@
 """Tests for the tinyflux.point module."""
+
 from datetime import datetime, timezone, timedelta
 import pytest
 from tinyflux.point import Point, validate_tags, validate_fields
@@ -284,7 +285,7 @@ def test_points_are_equal():
 
 
 def test_serialize_point():
-    """Test serializaiton of a Point object."""
+    """Test serialization of a Point object."""
     time_now = datetime.now(timezone.utc)
     time_now_str = time_now.replace(tzinfo=None).isoformat()
 

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/test_queries.py

@@ -1,4 +1,5 @@
 """Tests for the tinyflux.queries module."""
+
 import operator
 from datetime import datetime, timezone, timedelta
 from itertools import combinations
@@ -75,7 +76,7 @@ def test_repr():
 
 
 def test_no_path():
-    """Test absense of path for Tag and Field queries.
+    """Test absence of path for Tag and Field queries.
 
     TagQuery and FieldQuery should have paths.
     """
@@ -226,7 +227,7 @@ def test_lt():
     # Test for tag key "city".
     taq_q = TagQuery().city < "melbourne"
     assert taq_q(Point(tags={"city": "amsterdam"}))
-    assert not taq_q(Point(tags={"city": "zansibar"}))
+    assert not taq_q(Point(tags={"city": "zanzibar"}))
     assert not taq_q(Point())
     assert hash(taq_q)
 
@@ -258,7 +259,7 @@ def test_le():
     # Test for tag key "city".
     taq_q = TagQuery().city <= "melbourne"
     assert taq_q(Point(tags={"city": "melbourne"}))
-    assert not taq_q(Point(tags={"city": "zansibar"}))
+    assert not taq_q(Point(tags={"city": "zanzibar"}))
     assert not taq_q(Point())
     assert hash(taq_q)
 
@@ -289,7 +290,7 @@ def test_gt():
     """Test simple greater than comparison."""
     # Test for tag key "city".
     taq_q = TagQuery().city > "melbourne"
-    assert taq_q(Point(tags={"city": "zansibar"}))
+    assert taq_q(Point(tags={"city": "zanzibar"}))
     assert not taq_q(Point(tags={"city": "amsterdam"}))
     assert not taq_q(Point())
     assert hash(taq_q)

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/test_storages.py

@@ -1,4 +1,5 @@
 """Tests for the tinyflux.storages module."""
+
 import csv
 from datetime import datetime, timezone, timedelta
 import os
@@ -102,7 +103,7 @@ def test_csv_write_read(tmpdir):
 
 
 def test_csv_kwargs(tmpdir):
-    """Test kwargs propogation."""
+    """Test kwargs propagation."""
     dbfile = os.path.join(tmpdir, "test.csv")
 
     # Pass the 'delimiter' kwarg from csv module.
@@ -133,9 +134,9 @@ def test_create_dirs():
     temp_dir = tempfile.gettempdir()
 
     while True:
-        dname = os.path.join(temp_dir, str(random.getrandbits(20)))
-        if not os.path.exists(dname):
-            dbdir = dname
+        dbname = os.path.join(temp_dir, str(random.getrandbits(20)))
+        if not os.path.exists(dbname):
+            dbdir = dbname
             dbfile = os.path.join(dbdir, "db.json")
             break
 
@@ -363,7 +364,7 @@ def test_connect_to_existing_csv(tmpdir, csv_storage_with_counters):
     storage.append([storage._serialize_point(p3)])
     assert storage.reindex_count == 0
 
-    # Read without reindexing.
+    # Read without re-indexing.
     assert storage.read() == [p2, p1, p3]
     assert storage.reindex_count == 0
     assert storage.write_count == 0
@@ -441,7 +442,7 @@ def test_reindex_on_read_memory(mem_storage_with_counters):
     assert storage.reindex_count == 0
     assert storage.write_count == 0
 
-    # Read contents with reindexing.
+    # Read contents with re-indexing.
     storage.read()
     assert storage.append_count == 3
     assert storage.reindex_count == 0

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/test_tinyflux.py

@@ -2,6 +2,7 @@
 
 Tests are generally organized by TinyFlux class method.
 """
+
 import csv
 from datetime import datetime, timezone, timedelta
 import os
@@ -625,7 +626,7 @@ def test_measurement():
     assert not db._measurements
     assert not db.get_measurements()
 
-    # Create a reference to a measurment that does not exist.
+    # Create a reference to a measurement that does not exist.
     m = db.measurement("a")
     assert "a" in db._measurements
     assert not len(m)

{tinyflux-0.4.0 → tinyflux-0.4.2}/tests/test_utils.py

@@ -1,4 +1,5 @@
 """Tests for tinyflux.utils module."""
+
 import pytest
 
 from tinyflux.utils import (
@@ -35,7 +36,7 @@ def test_freeze():
 
 
 def test_frozen_dict_hash():
-    """Tesh the hash function on FrozenDict class."""
+    """Test the hash function on FrozenDict class."""
     my_frozen_set1 = FrozenDict({"city": "la", "state": "ca"})
     my_frozen_set2 = FrozenDict({"state": "ca", "city": "la"})
     my_frozen_set3 = FrozenDict({"temp": 70})

{tinyflux-0.4.0 → tinyflux-0.4.2}/tinyflux/__init__.py

@@ -27,6 +27,7 @@ Usage:
     >>> q2 = FieldQuery().aqi > 100
     >>> hazardous_days_in_LA_2020 = db.search(q1 & q2)
 """
+
 from .database import TinyFlux
 from .point import Point
 from .queries import TagQuery, FieldQuery, MeasurementQuery, TimeQuery

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

@@ -1,4 +1,5 @@
 """The main module of the TinyFlux package, containing the TinyFlux class."""
+
 import copy
 from datetime import datetime, timezone
 from functools import wraps
@@ -164,7 +165,7 @@ class TinyFlux:
         'auto-index' to False.
 
         Args:
-            auto_index: Reindexing of data will be performed automatically.
+            auto_index: Re-indexing of data will be performed automatically.
             storage: Class of Storage instance.
         """
         self._auto_index = auto_index
@@ -213,7 +214,7 @@ class TinyFlux:
         return
 
     def __iter__(self) -> Iterator[Point]:
-        """Return an iterater for all Points in the storage layer."""
+        """Return an iterator for all Points in the storage layer."""
         for item in self._storage:
             yield self._storage._deserialize_storage_item(item)
 
@@ -687,7 +688,7 @@ class TinyFlux:
             1 if success.
 
         Raises:
-            OSError if storage cannot be appendex to.
+            OSError if storage cannot be appended to.
             TypeError if point is not a Point instance.
         """
         return self._insert_helper([point], measurement, compact_key_prefixes)
@@ -710,7 +711,7 @@ class TinyFlux:
             The count of inserted points.
 
         Raises:
-            OSError if storage cannot be appendex to.
+            OSError if storage cannot be appended to.
             TypeError if point is not a Point instance.
         """
         return self._insert_helper(points, measurement, compact_key_prefixes)
@@ -896,7 +897,7 @@ class TinyFlux:
     ) -> List[Union[Any, Tuple[Any, ...]]]:
         """Get specified attributes from Points specified by a query.
 
-        'select_keys' should be an iterable of attributres including 'time',
+        'select_keys' should be an iterable of attributes including 'time',
         'measurement', and tag keys and tag values.  Passing 'tags' or 'fields'
         in the 'select_keys' iterable will not retrieve all tag and/or field
         values.  Tag and field keys must be specified individually.
@@ -1330,7 +1331,7 @@ class TinyFlux:
             if self._auto_index and self._index.valid:
                 if (
                     not self._index.empty
-                    and point.time < self._index.lateset_time
+                    and point.time < self._index.latest_time
                 ):
                     self._index.invalidate()
                 else:

{tinyflux-0.4.0 → tinyflux-0.4.2}/tinyflux/index.py

@@ -1,13 +1,14 @@
-"""Defintion of the TinyFlux Index.
+"""Definition of the TinyFlux Index.
 
 Class descriptions for Index and IndexResult.  An Index acts like a singleton,
 and is initialized at creation time with the TinyFlux instance. It provides
 efficient in-memory data structures and getters for TinyFlux operations. An
 Index instance is not a part of the TinyFlux interface.
 
-An IndexResult returns the indicies of revelant TinyFlux queries for further
+An IndexResult returns the indices of relevant TinyFlux queries for further
 handling, usually as an input to a storage retrieval.
 """
+
 from datetime import datetime, timezone
 import operator
 from typing import Dict, Iterable, List, Optional, Set, Tuple, Union
@@ -18,12 +19,12 @@ from .utils import find_eq, find_lt, find_le, find_gt, find_ge
 
 
 class IndexResult:
-    """Returns indicies of TinyFlux queries that are handled by an Index.
+    """Returns indices of TinyFlux queries that are handled by an Index.
 
     IndexResults instances are generated by an Index.
 
-    Arritributes:
-        items: A set of indicies as ints.
+    Attributes:
+        items: A set of indices as ints.
 
     Usage:
         >>> IndexResult(items=set(), index_count=0)
@@ -36,7 +37,7 @@ class IndexResult:
         """Init IndexResult.
 
         Args:
-            items: Matching items from a query as indicies.
+            items: Matching items from a query as indices.
             index_count: Number of items in the index..
         """
         self._items = items
@@ -148,8 +149,8 @@ class Index:
         return self._valid
 
     @property
-    def lateset_time(self) -> datetime:
-        """Return the lastest time in the index."""
+    def latest_time(self) -> datetime:
+        """Return the latest time in the index."""
         return datetime.fromtimestamp(self._timestamps[-1]).astimezone(
             timezone.utc
         )

{tinyflux-0.4.0 → tinyflux-0.4.2}/tinyflux/measurement.py

@@ -1,4 +1,4 @@
-"""Defintion of TinyFlux measurement class.
+"""Definition of TinyFlux measurement class.
 
 The measurement class provides a convenient interface into a subset of
 data points with a common measurement name.  A measurement is analogous to a
@@ -8,6 +8,7 @@ Usage:
     >>> db = TinyFlux(storage=MemoryStorage)
     >>> m = db.measurement("my_measurement")
 """
+
 from __future__ import annotations
 
 from datetime import datetime
@@ -298,7 +299,7 @@ class Measurement:
     ) -> List[Tuple[Union[datetime, str, int, float, None]]]:
         """Get specified attributes from Points specified by a query.
 
-        'keys' should be an iterable of attributres including 'time',
+        'keys' should be an iterable of attributes including 'time',
         'measurement', and tag keys and tag values.  Passing 'tags' or 'fields'
         in the 'keys' iterable will not retrieve all tag and/or field values.
         Tag and field keys must be specified individually.

{tinyflux-0.4.0 → tinyflux-0.4.2}/tinyflux/point.py

@@ -1,8 +1,8 @@
-"""Defintion of the TinyFlux Point class.
+"""Definition of the TinyFlux Point class.
 
 A Point is the data type upon which TinyFlux manages.  It contains the time
 data and metadata for an individual observation.  Points are serialized and
-deserialized from Storage.  SimpleQuerys act upon individual Points.
+deserialized from Storage. SimpleQuery act upon individual Points.
 
 A Point is comprised of a timestamp, a measurement, fields, and tags.
 

{tinyflux-0.4.0 → tinyflux-0.4.2}/tinyflux/queries.py

@@ -1,4 +1,4 @@
-"""Defintion of TinyFlux Queries.
+"""Definition of TinyFlux Queries.
 
 A query contains logic in the form of a test and it acts upon a single Point
 when it is eventually evaluated.
@@ -10,10 +10,11 @@ instances support logical AND, OR, and NOT operations, which result in the
 initialization of a new CompoundQuery object.
 
 Each SimpleQuery instance contains attributes that constitute the
-"deconstuction" of a query into several key parts (e.g. the operator, the
-right-hand side) so that the other consumers of queries, includng an Index, may
+"deconstruction" of a query into several key parts (e.g. the operator, the
+right-hand side) so that the other consumers of queries, including an Index, may
 use them for their own purposes.
 """
+
 from datetime import datetime
 import operator
 import re
@@ -214,7 +215,7 @@ class SimpleQuery:
             operator: The operator portion of a test.
             rhs: The value that a test should evaluated against.
             test: The combined logic as a callable.
-            path_resolver: A fetcher/translater for Point metadata that the
+            path_resolver: A fetcher/translator for Point metadata that the
                            query will be evaluated on.
             hashval: The hash value for the query.
         """
@@ -323,10 +324,10 @@ class SimpleQuery:
 class BaseQuery:
     """A base class for the different TinyFlux query types.
 
-    A query type that explicity unifies the divergent interfaces of TimeQuery,
+    A query type that explicitly unifies the divergent interfaces of TimeQuery,
     MeasurementQuery, TagQuery, and FieldQuery.
 
-    A BaseQuery is not iteslf callable. When it is combined with test logic,
+    A BaseQuery is not itself callable. When it is combined with test logic,
     it generates a SimpleQuery, which is callable without exception.
 
     Usage:
@@ -421,7 +422,7 @@ class BaseQuery:
         Args:
             operator: A Callable.
             rhs: A value to test against.
-            test_against_rhs: Whether the test should evaulate against RHS.
+            test_against_rhs: Whether the test should evaluate against RHS.
             hashval: The hash value for the query.
         """
         # Make sure this query has some keys if they are required.
@@ -468,7 +469,7 @@ class BaseQuery:
             raise TypeError("FieldQuery comparison value must be numeric.")
 
         def test(x: Any) -> bool:
-            """The test function from an operator and righthand side."""
+            """The test function from an operator and right-hand side."""
             if not test_against_rhs:
                 return operator(x, *args) if args else operator(x)
 
@@ -655,7 +656,7 @@ class BaseQuery:
         >>> FieldQuery()["my field"].test(test_func)
 
         Warning:
-            The test fuction provided needs to be deterministic (returning the
+            The test function provided needs to be deterministic (returning the
             same value when provided with the same arguments), otherwise this
             may mess up the query cache that :class:`~tinyflux.table.Table`
             implements.

{tinyflux-0.4.0 → tinyflux-0.4.2}/tinyflux/storages.py

@@ -1,4 +1,4 @@
-"""Defintion of TinyFlux storages classes.
+"""Definition of TinyFlux storages classes.
 
 Storage defines an abstract base case using the built-in ABC of python. This
 class defines the requires abstract methods of read, write, and append, as well
@@ -13,6 +13,7 @@ Usage:
     >>> my_mem_db = TinyFlux(storage=MemoryStorage)
     >>> my_csv_db = TinyFlux('path/to/my.csv', storage=CSVStorage)
 """
+
 from abc import ABC, abstractmethod
 import csv
 from datetime import datetime
@@ -58,7 +59,7 @@ class Storage(ABC):  # pragma: no cover
     Defines an extensible, static interface with required read/write ops and
     index-related getter/setters.
 
-    Custom storage classes should inheret like so:
+    Custom storage classes should inherit like so:
         >>> from tinyflux import Storage
         >>> class MyStorageClass(Storage):
                 ...
@@ -96,7 +97,7 @@ class Storage(ABC):  # pragma: no cover
         """Append points to the store.
 
         Args:
-            points: A list of Point objets.
+            points: A list of Point objects.
             temporary: Whether or not to append to temporary storage.
         """
         ...

{tinyflux-0.4.0 → tinyflux-0.4.2}/tinyflux/utils.py

@@ -1,4 +1,5 @@
-"""Defintion of TinyFlux utils."""
+"""Definition of TinyFlux utils."""
+
 import bisect
 from typing import Any, List, Optional
 

tinyflux-0.4.2/tinyflux/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinyflux
-Version: 0.4.0
+Version: 0.4.2
 Summary: The Tiny Time-Series Database Optimized for Your Happiness
 Home-page: https://github.com/citrusvanilla/tinyflux
 Author: Justin Fung
@@ -22,6 +22,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 :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Operating System :: OS Independent
@@ -36,8 +37,13 @@ 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 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.
+
 |Build Status| |Coverage| |Version| |Downloads|
 
+
 Quick Links
 ***********
 
@@ -48,49 +54,19 @@ Quick Links
 - `Contributing`_
 
 
-Recent Updates
-**************
-
-v0.4.0 - March 27, 2023
-=======================
-
-* Tags and Fields can be removed from individual points. See `the documentation <https://tinyflux.readthedocs.io/en/latest/updating-data.html#removing-tags-and-fields-with-update>`__ for more (resolves issue #27).
-
-v0.3.1 - March 27, 2023
-=======================
-
-* Fixed bug that allowed user to delete key/field tags with `.update()` and `.update_all()` (resolves issue #36).
-
-v0.3.0 - March 23, 2023
-=======================
-
-* Tag and field keys can be compacted when using CSVStorage, saving potentially many bytes per Point (resolves issue #32).
-* Fixed bug that causes tag values of `""` to be serialized as `"_none"` (resolves issue #33).
-
-See the `Changelog <https://tinyflux.readthedocs.io/en/latest/changelog.html>`__ for more.
-
-
 Installation
 ************
 
-.. code-block:: bash
-
-    $ pip install tinyflux
-
-Or, download this repository, ``cd`` into it, and:
+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.
 
 .. code-block:: bash
 
-    $ pip install .
+    $ pip install tinyflux
 
 
 Introduction
 ************
 
-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 is:
 
 - **time-centric:** Python datetime objects are first-class citizens and queries are optimized for time, above all else.
@@ -109,10 +85,6 @@ TinyFlux is:
 
 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>`__.
 
-Supported Python Versions
-*************************
-
-TinyFlux has been tested with Python 3.7 - 3.11 and PyPy-3.9 on Linux and Windows platforms.
 
 Example Code Snippets
 *********************
@@ -168,6 +140,7 @@ The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`_
 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>`__
 3. `TinyFlux as a MQTT Datastore for IoT Devices <https://github.com/citrusvanilla/tinyflux/blob/master/examples/3_iot_datastore_with_mqtt.py>`__
+4. `TinyFlux at the Edge (with Backup Strategy) <https://github.com/citrusvanilla/tinyflux/blob/master/examples/4_backing_up_tinyflux_at_the_edge.py>`__
 
 Tips
 ****
@@ -196,8 +169,9 @@ New ideas, new developer tools, improvements, and bugfixes are always welcome.
 5. Send a pull request.
 
 .. |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
+   :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

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

@@ -3,7 +3,6 @@ MANIFEST.in
 README.rst
 pyproject.toml
 setup.cfg
-version.txt
 tests/__init__.py
 tests/conftest.py
 tests/test_index.py
@@ -22,6 +21,7 @@ tinyflux/py.typed
 tinyflux/queries.py
 tinyflux/storages.py
 tinyflux/utils.py
+tinyflux/version.py
 tinyflux.egg-info/PKG-INFO
 tinyflux.egg-info/SOURCES.txt
 tinyflux.egg-info/dependency_links.txt

tinyflux-0.4.0/MANIFEST.in

@@ -1,3 +0,0 @@
-include LICENSE
-include version.txt
-recursive-include tests *.py

tinyflux-0.4.0/version.txt

@@ -1 +0,0 @@
-v0.4.0