Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
> - `Fixed` for any bug fixes.
> - `Security` in case of vulnerabilities.

## [0.3.1]

### Changed

- Package metadata improved for discoverability: a more descriptive summary, expanded
keywords (e.g. `radial-heatmap`, `time-series`, `visualization`) and the classifiers;
`Topic :: Scientific/Engineering :: Visualization`,
`Topic :: Scientific/Engineering :: Information Analysis` and `Typing :: Typed`.

### Fixed

- The documentation sidebar shows the package version again, below the project name.

## [0.3.0] - 2026-09-26

### Breaking changes
Expand Down
11 changes: 11 additions & 0 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ git-prune:
symlink-agents:
@uv run python -c "import pathlib; p=pathlib.Path('CLAUDE.md'); p.unlink(missing_ok=True); p.symlink_to('AGENTS.md')"

[doc("Bump version, tag & trigger release")]
[group("DEV")]
release PART:
git fetch --prune
git switch main && git pull
uv run run bump-my-version {{PART}}
git push --atomic origin main --follow-tags
git switch develop && git pull
git merge --ff-only main
git push origin develop

[doc("Build Sphinx HTML documentation (warnings treated as errors)")]
[group("DOCS")]
docs:
Expand Down
14 changes: 14 additions & 0 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{% extends "!layout.html" %}

{% block sidebartitle %}
{%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %}
{%- set _root_doc = root_doc|default(master_doc) %}
<a href="{{ pathto(_root_doc) }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}>
{% if not theme_logo_only %}{{ project }}{% endif %}
{%- if logo or logo_url %}
<img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
{%- endif %}
</a>
<div class="version">{{ version }}</div>
{%- include "searchbox.html" %}
{% endblock %}
6 changes: 4 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@

# List of patterns, relative to source directory, that match files and
# exclude_patterns; "_build", "Thumbs.db", ".DS_Store"
exclude_patterns = []
exclude_patterns: list[str] = []

# theme template overrides (e.g. version in the sidebar)
templates_path = ["_templates"]

# autodoc: types are rendered in the parameter descriptions, not the signature
autodoc_typehints = "description"
Expand All @@ -49,5 +52,4 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_theme_options = {"version_selector": True}
html_static_path = ["_static"]
4 changes: 1 addition & 3 deletions prek.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[[repos]]
repo = "https://gitlab.com/andyrids/pkgdx"
rev = "v0.3.0"
rev = "v0.4.0"

[[repos.hooks]]
id = "pkgdx-lint"
Expand All @@ -27,8 +27,6 @@ repo = "local"
id = "pkgdx-typing"
name = "Typing [Mypy]"
entry = "uv run pkgdx-typing-hook"
# workaround: pkgdx v0.3.0 ships this hook with no target (args = [])
args = ["src"]
language = "system"
types_or = ["python", "pyi"]
exclude = "tests/"
Expand Down
24 changes: 22 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "dataclocklib"
description = "Dataclock charts using matplotlib."
description = "Data clock charts (radial temporal heatmaps) for pandas time series, built on matplotlib."
authors = [{name = "Andrew Ridyard", email = "developer.surface832@passmail.com"}]
maintainers = [{name = "Andrew Ridyard", email = "developer.surface832@passmail.com"}]
dynamic = ["version"]
Expand All @@ -21,9 +21,29 @@ classifiers=[
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
"Topic :: Scientific/Engineering :: Information Analysis",
"Topic :: Scientific/Engineering :: Visualization",
"Topic :: Software Development :: Libraries :: Python Modules",
"Typing :: Typed",
]
keywords = [
"dataclock",
"data-clock",
"data clock",
"matplotlib",
"pandas",
"visualisation",
"visualization",
"temporal",
"time-series",
"timeseries",
"polar-chart",
"radial-heatmap",
"circular-heatmap",
"calendar-heatmap",
"seasonality",
"cyclical-patterns",
]
keywords = ["matplotlib", "dataclock", "visualisation", "analysis"]
dependencies = [
"matplotlib>=3.10",
"pandas[parquet]>=3.0",
Expand Down
32 changes: 16 additions & 16 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading