prepare release

int-brain-lab · Oct 1, 2024 · 0342d9f · 0342d9f
1 parent e6fde18
commit 0342d9f
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
-## [0.1.0] - 2024-9-30
+## [0.1.0] - 2024-10-01
 
-_First release._
+_First release._
+
+### Added
+
+- core.DataFrameTableModel: A Qt TableModel for Pandas DataFrames.
+- core.ColoredDataFrameTableModel: An extension of DataFrameTableModel providing color-mapped numerical data.
+- widgets.StatefulButton: A QPushButton that maintains an active/inactive state.
+
+[0.1.0]: https://github.com/int-brain-lab/iblqt/releases/tag/v0.1.0
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
 # iblqt
+
+A collection of extensions to the Qt framework.
+
+The full API documentation is available [here](https://int-brain-lab.github.io/iblqt).
+
+![License](https://img.shields.io/github/license/int-brain-lab/iblqt)
+[![GitHub tag](https://img.shields.io/github/v/tag/int-brain-lab/iblqt)](https://github.com/int-brain-lab/iblqt/tags)
+[![PyPI](https://img.shields.io/pypi/v/iblqt)](https://pypi.org/project/iblqt/)
diff --git a/docs/source/_templates/custom-class-template.rst b/docs/source/_templates/custom-class-template.rst
@@ -2,11 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-   :parts: 1
-
-|
-
 .. autoclass:: {{ objname }}
    :members:
    :undoc-members:

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,5 +1,5 @@
-API
-===
+API Reference
+=============
 
 .. autosummary::
    :toctree: api

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,7 +24,6 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
-    'sphinx.ext.inheritance_diagram',
     'sphinx.ext.viewcode',
     'sphinx_qt_documentation',
     'myst_parser',

diff --git a/iblqt/__init__.py b/iblqt/__init__.py
@@ -1,3 +1,3 @@
-"""A collection of extensions and enhancements to the Qt framework."""
+"""A collection of extensions to the Qt framework."""
 
 __version__ = '0.1.0'
diff --git a/iblqt/core.py b/iblqt/core.py
@@ -24,7 +24,14 @@
 
 
 class DataFrameTableModel(QAbstractTableModel):
-    """A Qt TableModel for Pandas DataFrames."""
+    """
+    A Qt TableModel for Pandas DataFrames.
+
+    Attributes
+    ----------
+    dataFrame : Property
+        The DataFrame containing the models data.
+    """
 
     def __init__(
         self,

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,24 +4,36 @@ build-backend = "pdm.backend"
 
 [project]
 name = "iblqt"
-version = "0.1.0"
-description = "The International Brain Laboratory's Qt tools"
+description = "A collection of extensions to the Qt framework."
 dependencies = [
     "qtpy>=2.4.1",
     "pandas>2.0",
     "numpy",
     "pyqtgraph>=0.13.7",
 ]
+keywords = ["pyqt", "qt", "pyside", "qtpy"]
 requires-python = ">=3.10"
 readme = "README.md"
 license = {text = "MIT"}
 authors = [
     {name = "Florian Rau", email = "[email protected]"},
 ]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/int-brain-lab/iblqt/"
+Documentation = "https://int-brain-lab.github.io/iblqt/"
+Repository = "https://github.com/int-brain-lab/iblqt.git"
+Issues = "https://github.com/int-brain-lab/iblqt/issues"
+Changelog = "https://github.com/int-brain-lab/iblqt/blob/main/CHANGELOG.md"
 
 [tool.pdm]
 distribution = true
 
+[tool.pdm.version]
+source = "file"
+path = "iblqt/__init__.py"
+
 [tool.pdm.dev-dependencies]
 dev = [
     "iblqt[doc, lint, test, typing]",