tsbootstrap 0.0.1__tar.gz → 0.0.3__tar.gz

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/PKG-INFO

@@ -1,7 +1,8 @@
 Metadata-Version: 2.1
 Name: tsbootstrap
-Version: 0.0.1
+Version: 0.0.3
 Summary: A Python package to generate bootstrapped time series
+Home-page: https://tsbootstrap.readthedocs.io/en/latest/
 License: MIT
 Author: Sankalp Gilda
 Author-email: sankalp.gilda@gmail.com
@@ -24,15 +25,14 @@ Requires-Dist: numba (>=0.57,<0.58)
 Requires-Dist: pyclustering (>=0.10,<0.11)
 Requires-Dist: scikit_learn_extra (>=0.3,<0.4)
 Requires-Dist: scipy (>=1.10,<1.11)
-Requires-Dist: sphinx (>=7.1.2,<8.0.0)
-Requires-Dist: sphinx-rtd-theme (>=1.2.2,<2.0.0)
 Description-Content-Type: text/markdown
 
 <div align="center">
-    <h1 align="left">
+    <div style="float: left; margin-right: 20px;">
         <img src="https://github.com/astrogilda/tsbootstrap/blob/main/tsbootstrap_logo.png" width="120" />
-    </h1>
-    <h3>◦ Generate bootstrapped samples from time-series data.</h3>
+    </div>
+    <h3>Generate bootstrapped samples from time-series data. The full documentation is available <a href="https://tsbootstrap.readthedocs.io/en/latest/">here</a>.</h3>
+    <div style="clear: both;"></div>
     <br>
     <p align="center">
         <img src="https://img.shields.io/badge/Markdown-000000.svg?stylee&logo=Markdown&logoColor=white" alt="Markdown" />
@@ -51,14 +51,14 @@ Description-Content-Type: text/markdown
         <img src="https://img.shields.io/pypi/pyversions/tsbootstrap?color=5D6D7E&logo=python" alt="pypi-python-version" />
     </a>
     <a href="https://pypi.org/project/tsbootstrap/">
-        <img src="https://img.shields.io/pypi/dm/tsbootstrap?color=5D6D7E" alt="pypi-downloads" />
+        <img src="https://img.shields.io/pypi/dd/tsbootstrap?color=5D6D7E" alt="pypi-downloads" />
     </a>
     <img src="https://img.shields.io/github/license/eli64s/readme-ai?color=5D6D7E" alt="github-license" />
     </a>
     <img src="https://github.com/astrogilda/tsbootstrap/workflows/CI/badge.svg" alt="Build Status"/>
     <a href="https://codecov.io/gh/astrogilda/tsbootstrap"><img src="https://codecov.io/gh/astrogilda/tsbootstrap/branch/main/graph/badge.svg" alt="codecov"/></a>
     <a href="https://doi.org/10.5281/zenodo.8226496"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.8226496.svg" alt="DOI"/></a>
-    <img src="https://img.shields.io/codeclimate/maintainability/astrogilda/tsbootstrap" alt="Code Quality"/>
+    <a href="https://codeclimate.com/github/astrogilda/tsbootstrap/maintainability"><img src="https://api.codeclimate.com/v1/badges/d80a0615a8c00f31565c/maintainability" alt="Code Quality"/></a>
     <img src="https://img.shields.io/github/last-commit/astrogilda/tsbootstrap" alt="Last Commit"/>
     <img src="https://img.shields.io/github/issues/astrogilda/tsbootstrap" alt="Issues"/>
     <img src="https://img.shields.io/github/issues-pr/astrogilda/tsbootstrap" alt="Pull Requests"/>
@@ -165,17 +165,19 @@ The `tsbootstrap` package contains various modules that handle tasks such as boo
 
 | File                                                                                       | Summary                   |
 | ---                                                                                        | ---                       |
-| [setup.sh](https://github.com/astrogilda/tsbootstrap/blob/main/setup.sh)                         | HTTPStatus Exception: 429 |
-| [commitlint.config.js](https://github.com/astrogilda/tsbootstrap/blob/main/commitlint.config.js) | HTTPStatus Exception: 429 |
-| [CITATION.cff](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.cff)                 | HTTPStatus Exception: 429 |
-| [CODE_OF_CONDUCT.md](https://github.com/astrogilda/tsbootstrap/blob/main/CODE_OF_CONDUCT.md)                 | HTTPStatus Exception: 429 |
-| [CONTRIBUTING.md](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.md)                 | HTTPStatus Exception: 429 |
-| [.codeclimate.yml](https://github.com/astrogilda/tsbootstrap/blob/main/.codeclimate.yml)                 | HTTPStatus Exception: 429 |
-| [.gitignore](https://github.com/astrogilda/tsbootstrap/blob/main/.gitignore)                 | HTTPStatus Exception: 429 |
-| [.pre-commit-config.yaml](https://github.com/astrogilda/tsbootstrap/blob/main/.pre-commit-config.yaml)                 | HTTPStatus Exception: 429 |
-| [poetry.lock](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.lock)                 | HTTPStatus Exception: 429 |
-| [poetry.toml](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.toml)                 | HTTPStatus Exception: 429 |
-| [tsbootstrap_logo.png](https://github.com/astrogilda/tsbootstrap/blob/main/tsbootstrap_logo.png)                 | HTTPStatus Exception: 429 |
+| [setup.sh](https://github.com/astrogilda/tsbootstrap/blob/main/setup.sh)                         | Shell script for initial setup and environment configuration. |
+| [commitlint.config.js](https://github.com/astrogilda/tsbootstrap/blob/main/commitlint.config.js) | Configuration for enforcing conventional commit messages. |
+| [CITATION.cff](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.cff)                 | Citation metadata for the project. |
+| [CODE_OF_CONDUCT.md](https://github.com/astrogilda/tsbootstrap/blob/main/CODE_OF_CONDUCT.md)                 | Guidelines for community conduct and interactions. |
+| [CONTRIBUTING.md](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.md)                 | Instructions for contributing to the project. |
+| [.codeclimate.yml](https://github.com/astrogilda/tsbootstrap/blob/main/.codeclimate.yml)                 | Configuration for Code Climate quality checks. |
+| [.gitignore](https://github.com/astrogilda/tsbootstrap/blob/main/.gitignore)                 | Specifies files and folders to be ignored by Git. |
+| [.pre-commit-config.yaml](https://github.com/astrogilda/tsbootstrap/blob/main/.pre-commit-config.yaml)                 | Configuration for pre-commit hooks. |
+| [poetry.lock](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.lock)                 | Lock file generated by Poetry, pinning exact package versions. |
+| [poetry.toml](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.toml)                 | Configuration file for Poetry package management. |
+| [tsbootstrap_logo.png](https://github.com/astrogilda/tsbootstrap/blob/main/tsbootstrap_logo.png)                 | Project logo image. |
+
+</details>
 
 
 
@@ -288,8 +290,8 @@ mbb_config = MovingBlockBootstrapConfig(
 )
 mbb = MovingBlockBootstrap(config=mbb_config)
 
-# Generate 1000 bootstrapped samples
-bootstrapped_samples = bootstrap.sample(n=1000)
+# Generate the generator for 1000 bootstrapped samples
+bootstrapped_samples = bootstrap.bootstrap(n=1000)
 ```
 
 ### 🧪 Running Tests

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/README.md

@@ -1,8 +1,9 @@
 <div align="center">
-    <h1 align="left">
+    <div style="float: left; margin-right: 20px;">
         <img src="https://github.com/astrogilda/tsbootstrap/blob/main/tsbootstrap_logo.png" width="120" />
-    </h1>
-    <h3>◦ Generate bootstrapped samples from time-series data.</h3>
+    </div>
+    <h3>Generate bootstrapped samples from time-series data. The full documentation is available <a href="https://tsbootstrap.readthedocs.io/en/latest/">here</a>.</h3>
+    <div style="clear: both;"></div>
     <br>
     <p align="center">
         <img src="https://img.shields.io/badge/Markdown-000000.svg?stylee&logo=Markdown&logoColor=white" alt="Markdown" />
@@ -21,14 +22,14 @@
         <img src="https://img.shields.io/pypi/pyversions/tsbootstrap?color=5D6D7E&logo=python" alt="pypi-python-version" />
     </a>
     <a href="https://pypi.org/project/tsbootstrap/">
-        <img src="https://img.shields.io/pypi/dm/tsbootstrap?color=5D6D7E" alt="pypi-downloads" />
+        <img src="https://img.shields.io/pypi/dd/tsbootstrap?color=5D6D7E" alt="pypi-downloads" />
     </a>
     <img src="https://img.shields.io/github/license/eli64s/readme-ai?color=5D6D7E" alt="github-license" />
     </a>
     <img src="https://github.com/astrogilda/tsbootstrap/workflows/CI/badge.svg" alt="Build Status"/>
     <a href="https://codecov.io/gh/astrogilda/tsbootstrap"><img src="https://codecov.io/gh/astrogilda/tsbootstrap/branch/main/graph/badge.svg" alt="codecov"/></a>
     <a href="https://doi.org/10.5281/zenodo.8226496"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.8226496.svg" alt="DOI"/></a>
-    <img src="https://img.shields.io/codeclimate/maintainability/astrogilda/tsbootstrap" alt="Code Quality"/>
+    <a href="https://codeclimate.com/github/astrogilda/tsbootstrap/maintainability"><img src="https://api.codeclimate.com/v1/badges/d80a0615a8c00f31565c/maintainability" alt="Code Quality"/></a>
     <img src="https://img.shields.io/github/last-commit/astrogilda/tsbootstrap" alt="Last Commit"/>
     <img src="https://img.shields.io/github/issues/astrogilda/tsbootstrap" alt="Issues"/>
     <img src="https://img.shields.io/github/issues-pr/astrogilda/tsbootstrap" alt="Pull Requests"/>
@@ -135,17 +136,19 @@ The `tsbootstrap` package contains various modules that handle tasks such as boo
 
 | File                                                                                       | Summary                   |
 | ---                                                                                        | ---                       |
-| [setup.sh](https://github.com/astrogilda/tsbootstrap/blob/main/setup.sh)                         | HTTPStatus Exception: 429 |
-| [commitlint.config.js](https://github.com/astrogilda/tsbootstrap/blob/main/commitlint.config.js) | HTTPStatus Exception: 429 |
-| [CITATION.cff](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.cff)                 | HTTPStatus Exception: 429 |
-| [CODE_OF_CONDUCT.md](https://github.com/astrogilda/tsbootstrap/blob/main/CODE_OF_CONDUCT.md)                 | HTTPStatus Exception: 429 |
-| [CONTRIBUTING.md](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.md)                 | HTTPStatus Exception: 429 |
-| [.codeclimate.yml](https://github.com/astrogilda/tsbootstrap/blob/main/.codeclimate.yml)                 | HTTPStatus Exception: 429 |
-| [.gitignore](https://github.com/astrogilda/tsbootstrap/blob/main/.gitignore)                 | HTTPStatus Exception: 429 |
-| [.pre-commit-config.yaml](https://github.com/astrogilda/tsbootstrap/blob/main/.pre-commit-config.yaml)                 | HTTPStatus Exception: 429 |
-| [poetry.lock](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.lock)                 | HTTPStatus Exception: 429 |
-| [poetry.toml](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.toml)                 | HTTPStatus Exception: 429 |
-| [tsbootstrap_logo.png](https://github.com/astrogilda/tsbootstrap/blob/main/tsbootstrap_logo.png)                 | HTTPStatus Exception: 429 |
+| [setup.sh](https://github.com/astrogilda/tsbootstrap/blob/main/setup.sh)                         | Shell script for initial setup and environment configuration. |
+| [commitlint.config.js](https://github.com/astrogilda/tsbootstrap/blob/main/commitlint.config.js) | Configuration for enforcing conventional commit messages. |
+| [CITATION.cff](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.cff)                 | Citation metadata for the project. |
+| [CODE_OF_CONDUCT.md](https://github.com/astrogilda/tsbootstrap/blob/main/CODE_OF_CONDUCT.md)                 | Guidelines for community conduct and interactions. |
+| [CONTRIBUTING.md](https://github.com/astrogilda/tsbootstrap/blob/main/CITATION.md)                 | Instructions for contributing to the project. |
+| [.codeclimate.yml](https://github.com/astrogilda/tsbootstrap/blob/main/.codeclimate.yml)                 | Configuration for Code Climate quality checks. |
+| [.gitignore](https://github.com/astrogilda/tsbootstrap/blob/main/.gitignore)                 | Specifies files and folders to be ignored by Git. |
+| [.pre-commit-config.yaml](https://github.com/astrogilda/tsbootstrap/blob/main/.pre-commit-config.yaml)                 | Configuration for pre-commit hooks. |
+| [poetry.lock](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.lock)                 | Lock file generated by Poetry, pinning exact package versions. |
+| [poetry.toml](https://github.com/astrogilda/tsbootstrap/blob/main/poetry.toml)                 | Configuration file for Poetry package management. |
+| [tsbootstrap_logo.png](https://github.com/astrogilda/tsbootstrap/blob/main/tsbootstrap_logo.png)                 | Project logo image. |
+
+</details>
 
 
 
@@ -258,8 +261,8 @@ mbb_config = MovingBlockBootstrapConfig(
 )
 mbb = MovingBlockBootstrap(config=mbb_config)
 
-# Generate 1000 bootstrapped samples
-bootstrapped_samples = bootstrap.sample(n=1000)
+# Generate the generator for 1000 bootstrapped samples
+bootstrapped_samples = bootstrap.bootstrap(n=1000)
 ```
 
 ### 🧪 Running Tests

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tsbootstrap"
-version = "0.0.1"
+version = "0.0.3"
 description = "A Python package to generate bootstrapped time series"
 authors = ["Sankalp Gilda <sankalp.gilda@gmail.com>"]
 license = "MIT"
@@ -19,6 +19,7 @@ packages = [
     { include = "tsbootstrap", from = "src" },
 ]
 include = ["src/tsbootstrap/py.typed"]
+homepage = "https://tsbootstrap.readthedocs.io/en/latest/"
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.12"
@@ -30,8 +31,6 @@ scikit_learn_extra = "~0.3"
 cython = "~3.0"
 importlib-metadata = "~6.8"
 scipy = "~1.10"
-sphinx = "^7.1.2"
-sphinx-rtd-theme = "^1.2.2"
 furo = "^2023.7.26"
 
 [tool.poetry.dev-dependencies]
@@ -54,6 +53,7 @@ pycobertura = "~3.2"
 [tool.poetry.group.dev.dependencies]
 sphinx = "^7.1.2"
 sphinx-rtd-theme = "^1.2.2"
+bumpversion = "^0.6.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/src/tsbootstrap/base_bootstrap_configs.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from collections.abc import Callable
-from email.mime import base
 from numbers import Integral
 
 import numpy as np

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/src/tsbootstrap/block_bootstrap.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from email.mime import base
 from typing import TYPE_CHECKING
 
 import numpy as np
@@ -281,15 +280,6 @@ class MovingBlockBootstrap(BlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "blocks": self.blocks,
-            "block_resampler": self.block_resampler,
-        }
-    """
-
 
 class StationaryBlockBootstrap(BlockBootstrap):
     r"""
@@ -343,20 +333,6 @@ class StationaryBlockBootstrap(BlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "blocks": self.blocks,
-            "block_resampler": self.block_resampler,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        self.config = state["config"]
-        self.blocks = state["blocks"]
-        self.block_resampler = state["block_resampler"]
-    """
-
 
 class CircularBlockBootstrap(BlockBootstrap):
     r"""
@@ -413,20 +389,6 @@ class CircularBlockBootstrap(BlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "blocks": self.blocks,
-            "block_resampler": self.block_resampler,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        self.config = state["config"]
-        self.blocks = state["blocks"]
-        self.block_resampler = state["block_resampler"]
-    """
-
 
 class NonOverlappingBlockBootstrap(BlockBootstrap):
     r"""
@@ -485,20 +447,6 @@ class NonOverlappingBlockBootstrap(BlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "blocks": self.blocks,
-            "block_resampler": self.block_resampler,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        self.config = state["config"]
-        self.blocks = state["blocks"]
-        self.block_resampler = state["block_resampler"]
-    """
-
 
 # Be cautious when using the default windowing functions from numpy, as they drop to 0 at the edges.This could be particularly problematic for smaller block_lengths. In the current implementation, we have clipped the min to 0.1, in block_resampler.py.
 
@@ -534,18 +482,6 @@ class BartlettsBootstrap(BaseBlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "bootstrap_instance": self.bootstrap_instance,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        self.config = state["config"]
-        self.bootstrap_instance = state["bootstrap_instance"]
-    """
-
 
 class HammingBootstrap(BaseBlockBootstrap):
     r"""
@@ -592,18 +528,6 @@ class HammingBootstrap(BaseBlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "bootstrap_instance": self.bootstrap_instance,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        self.config = state["config"]
-        self.bootstrap_instance = state["bootstrap_instance"]
-    """
-
 
 class HanningBootstrap(BaseBlockBootstrap):
     r"""
@@ -650,22 +574,6 @@ class HanningBootstrap(BaseBlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "bootstrap_instance": self.bootstrap_instance,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        if ["config", "bootstrap_instance"] != state.keys():
-            raise ValueError(
-                "The state dictionary must contain the keys 'config' and 'bootstrap_instance'."
-            )
-        self.config = state["config"]
-        self.bootstrap_instance = state["bootstrap_instance"]
-    """
-
 
 class BlackmanBootstrap(BaseBlockBootstrap):
     r"""
@@ -712,22 +620,6 @@ class BlackmanBootstrap(BaseBlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "bootstrap_instance": self.bootstrap_instance,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        if ["config", "bootstrap_instance"] != state.keys():
-            raise ValueError(
-                "The state dictionary must contain the keys 'config' and 'bootstrap_instance'."
-            )
-        self.config = state["config"]
-        self.bootstrap_instance = state["bootstrap_instance"]
-    """
-
 
 class TukeyBootstrap(BaseBlockBootstrap):
     r"""
@@ -775,22 +667,6 @@ class TukeyBootstrap(BaseBlockBootstrap):
     def __hash__(self) -> int:
         return hash((super().__hash__(), self.config))
 
-    """
-    def __getstate__(self) -> dict[str, object]:
-        return {
-            "config": self.config,
-            "bootstrap_instance": self.bootstrap_instance,
-        }
-
-    def __setstate__(self, state: dict[str, object]) -> None:
-        if ["config", "bootstrap_instance"] != state.keys():
-            raise ValueError(
-                "The state dictionary must contain the keys 'config' and 'bootstrap_instance'."
-            )
-        self.config = state["config"]
-        self.bootstrap_instance = state["bootstrap_instance"]
-    """
-
 
 BLOCK_BOOTSTRAP_TYPES_DICT = {
     "nonoverlapping": NonOverlappingBlockBootstrap,

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/src/tsbootstrap/block_bootstrap_configs.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from collections.abc import Callable
-from email.mime import base
 from functools import partial
 from numbers import Integral
 
@@ -862,8 +861,6 @@ class TukeyBootstrapConfig(BaseBlockBootstrapConfig):
     `tapered_weights` to Tukey window and `bootstrap_type` to "moving".
     """
 
-    tukey_alpha = staticmethod(partial(tukey, alpha=0.5))
-
     def __init__(
         self,
         block_length: None | Integral = None,
@@ -889,8 +886,9 @@ class TukeyBootstrapConfig(BaseBlockBootstrapConfig):
         super().__init__(block_length=block_length, **kwargs)
 
         # Set the properties directly
+        alpha = kwargs.get("alpha", 0.5)
         self._bootstrap_type = "moving"
-        self._tapered_weights = self.tukey_alpha
+        self._tapered_weights = partial(tukey, alpha=alpha)
 
     def __repr__(self) -> str:
         """Return repr(self)."""

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/src/tsbootstrap/block_length_sampler.py

@@ -33,7 +33,6 @@ DISTRIBUTION_METHODS = {
 
 import warnings
 from numbers import Integral
-from typing import Optional
 
 import numpy as np
 from numpy.random import Generator

{tsbootstrap-0.0.1 → tsbootstrap-0.0.3}/src/tsbootstrap/tsfit.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 import math
 import warnings
-from multiprocessing import Value
 from numbers import Integral
 
 import numpy as np