diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 01b43fb..5d34913 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,16 +1,17 @@ ---- +______________________________________________________________________ + name: ➕ Feature request about: Suggest an idea for this project title: '' description: What is your feature request ? -title: "[FEATURE] " -labels: [enhancement, triage] +title: "\[FEATURE\] <title>" +labels: \[enhancement, triage\] assignees: ghiggi ---- +______________________________________________________________________ **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...\] **Describe the solution you'd like** A clear and concise description of what you want to happen. Please explain why and how it helps your users. diff --git a/.github/ISSUE_TEMPLATE/performance.md b/.github/ISSUE_TEMPLATE/performance.md index c4149da..a50595a 100644 --- a/.github/ISSUE_TEMPLATE/performance.md +++ b/.github/ISSUE_TEMPLATE/performance.md @@ -1,10 +1,6 @@ ---- -name: 🐢 Performance -about: "Runtime, memory, speed, or storage inefficiency" -title: "" -labels: "topic: performance" -assignees: ghiggi ---- +______________________________________________________________________ + +## name: 🐢 Performance about: "Runtime, memory, speed, or storage inefficiency" title: "" labels: "topic: performance" assignees: ghiggi ## Prework diff --git a/AUTHORS.md b/AUTHORS.md index ca4a468..b2fdfa9 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -2,7 +2,5 @@ The following people have made contributions to this project: - - [Gionata Ghiggi (ghiggi)](https://github.com/ghiggi) - EPFL - [Marti Bosch (martibosch)](https://github.com/martibosch) - EPFL - diff --git a/CHANGELOG.md b/CHANGELOG.md index e385f59..ff993b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,5 @@ # Changelog - ## Version 0.0.1 - TStore Birth Date - 2023-01-11 First release of TStore. diff --git a/ci/environment.yml b/ci/environment.yml index e8a56e7..4abdc0d 100644 --- a/ci/environment.yml +++ b/ci/environment.yml @@ -1,17 +1,13 @@ name: ts-store channels: - - conda-forge +- conda-forge dependencies: - - pandas - - pyarrow - - polars - - dask - - distributed - - dask - - distributed - # testing - - pytest - - pytest-cov - - pytest-mock - - pytest-sugar - +- dask +- distributed +- pandas +- polars +- pyarrow +- pytest +- pytest-cov +- pytest-mock +- pytest-sugar diff --git a/ci/environment_latest.yml b/ci/environment_latest.yml index 058a253..7a18db5 100644 --- a/ci/environment_latest.yml +++ b/ci/environment_latest.yml @@ -1,16 +1,13 @@ name: ts-store-latest channels: - - conda-forge +- conda-forge dependencies: - - pandas - - pyarrow - - polars - - dask - - distributed - - dask - - distributed - # testing - - pytest - - pytest-cov - - pytest-mock - - pytest-sugar +- dask +- distributed +- pandas +- polars +- pyarrow +- pytest +- pytest-cov +- pytest-mock +- pytest-sugar diff --git a/docs/README.md b/docs/README.md index c0ca3ed..95ba000 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ styled with [Book Theme](https://sphinx-book-theme.readthedocs.io/en/stable/inde All documentation source files are neatly organized in the `docs/` directory within the project's repository. ------------------------------------------------------------------ +______________________________________________________________________ ### Build the documentation @@ -45,5 +45,5 @@ It first cleans previous builds (`make clean`) and then generates fresh document **Note**: It's important to review the output of the command. Look out for warnings or errors and address them to ensure the documentation is accurate and complete. -By following these steps, you should have a local version of the TStore documentation in the ``docs/build/html/`` directory, +By following these steps, you should have a local version of the TStore documentation in the `docs/build/html/` directory, ready for review or deployment! diff --git a/docs/environment.yaml b/docs/environment.yaml index b3fa5e2..1117380 100644 --- a/docs/environment.yaml +++ b/docs/environment.yaml @@ -1,18 +1,18 @@ name: build-doc-tstore channels: - - conda-forge +- conda-forge dependencies: - - python>=3.9 +- docutils +- jupyter +- nbsphinx==0.9.3 +- pandoc +- pip +- python>=3.9 +- sphinx-book-theme==1.1.0 +- sphinx-gallery +- sphinx-mdinclude==0.5.3 +- sphinx==7.2.6 +- sphinxcontrib-youtube +- ts-store +- pip: - ts-store - - jupyter - - pandoc - - docutils - - nbsphinx==0.9.3 - - sphinx==7.2.6 - - sphinx-book-theme==1.1.0 - - sphinx-mdinclude==0.5.3 - - sphinx-gallery - - sphinxcontrib-youtube - - pip - - pip: - - ts-store diff --git a/docs/source/00_introduction.rst b/docs/source/00_introduction.rst index 18c03c2..1cdbd83 100644 --- a/docs/source/00_introduction.rst +++ b/docs/source/00_introduction.rst @@ -14,7 +14,7 @@ Concepts are introduced in a progressive manner, but feel free to skip to the se TSLONG --------------- - + TODO .. _tsdf: @@ -30,5 +30,3 @@ TSArray ~~~~~~~~ TODO - - diff --git a/docs/source/03_quickstart.rst b/docs/source/03_quickstart.rst index c21a1a3..d0f50f7 100644 --- a/docs/source/03_quickstart.rst +++ b/docs/source/03_quickstart.rst @@ -2,10 +2,9 @@ Quick Start =========== -TStore allows to manipulate efficiently timeseries database with ease. +TStore allows to manipulate efficiently timeseries database with ease. -TODO +TODO You are now ready to explore the various :ref:`tutorials <tutorials>` available in the documentation and learn more about the TStore functionalities. - diff --git a/tstore/__init__.py b/tstore/__init__.py index c5983df..4247977 100644 --- a/tstore/__init__.py +++ b/tstore/__init__.py @@ -1,4 +1,5 @@ """tstore.""" + import contextlib from importlib.metadata import PackageNotFoundError, version @@ -18,4 +19,4 @@ # Get version with contextlib.suppress(PackageNotFoundError): - __version__ = version("tstore") \ No newline at end of file + __version__ = version("tstore") diff --git a/tstore/_version.py b/tstore/_version.py index a6fc5c5..8e01183 100644 --- a/tstore/_version.py +++ b/tstore/_version.py @@ -3,6 +3,7 @@ TYPE_CHECKING = False if TYPE_CHECKING: from typing import Tuple, Union + VERSION_TUPLE = Tuple[Union[int, str], ...] else: VERSION_TUPLE = object