#173 Merge pull request from astropenguin/astropenguin/issue172

Release v1.0.0

.devcontainer/devcontainer.json

@@ -1,29 +1,25 @@
 {
     "name": "pandas-dataclasses",
-    "image":"python:3.13",
-    "onCreateCommand": "pip install poetry==1.8.5",
-    "postCreateCommand": "poetry install",
+    "image": "ghcr.io/astral-sh/uv:python3.12-bookworm",
+    "runArgs": [
+        "--name=pandas-dataclasses"
+    ],
     "containerEnv": {
-        "POETRY_VIRTUALENVS_CREATE": "false"
+        "UV_PROJECT_ENVIRONMENT": "/usr/local"
     },
+    "postCreateCommand": "uv sync --frozen",
     "customizations": {
         "vscode": {
             "extensions": [
-                "github.vscode-pull-request-github",
-                "mhutchie.git-graph",
-                "ms-python.python",
+                "ms-python.black-formatter",
                 "streetsidesoftware.code-spell-checker",
                 "tamasfe.even-better-toml"
             ],
             "settings": {
-                "files.insertFinalNewline": true,
-                "files.trimTrailingWhitespace": true,
-                "python.formatting.provider": "black",
                 "python.languageServer": "Pylance",
                 "[python]": {
-                    "editor.formatOnSave": true,
-                    "editor.insertSpaces": true,
-                    "editor.tabSize": 4
+                    "editor.defaultFormatter": "ms-python.black-formatter",
+                    "editor.formatOnSave": true
                 }
             }
         }

.github/workflows/docs.yaml

@@ -0,0 +1,26 @@
+name: Docs
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  job:
+    name: Docs
+    runs-on: ubuntu-latest
+    container: ghcr.io/astral-sh/uv:python3.12-bookworm
+    env:
+      UV_PROJECT_ENVIRONMENT: /usr/local
+    steps:
+      - uses: actions/checkout@v4
+      - run: echo "::set-output name=tag::${GITHUB_REF##*/}"
+        id: tag
+      - run: uv sync --frozen
+      - run: docs/build
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          destination_dir: ${{ steps.tag.outputs.tag }}
+          force_orphan: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build

.github/workflows/pypi.yml

@@ -9,12 +9,10 @@ jobs:
   job:
     name: PyPI
     runs-on: ubuntu-latest
+    container: ghcr.io/astral-sh/uv:python3.12-bookworm
     env:
-      POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
+      UV_PROJECT_ENVIRONMENT: /usr/local
+      UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v2
-        with:
-          python-version: "3.13"
-      - name: Publish package to PyPI
-        run: pip install poetry==1.8.5 && poetry publish --build
+      - run: uv build && uv publish

.github/workflows/tests.yml

@@ -10,29 +10,26 @@ on:
 
 jobs:
   job:
-    name: Test (Python ${{ matrix.python }})
+    name: Test (${{ matrix.env }})
     runs-on: ubuntu-latest
+    container: ghcr.io/astral-sh/uv:${{ matrix.env }}
     env:
-      POETRY_VIRTUALENVS_CREATE: false
+      PYTHON_DIRS: docs tests pandas_dataclasses
+      UV_PROJECT_ENVIRONMENT: /usr/local
     strategy:
       fail-fast: false
       matrix:
-        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        env:
+          - python3.9-bookworm
+          - python3.10-bookworm
+          - python3.11-bookworm
+          - python3.12-bookworm
+          - python3.13-bookworm
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python }}
-      - name: Install project dependencies
-        run: pip install poetry==1.8.5 && poetry install
-      - name: Test code's formatting (Black)
-        run: black --check docs tests pandas_dataclasses
-      - name: Test code's typing (Pyright)
-        run: pyright docs tests pandas_dataclasses
-      - name: Test code's typing (mypy)
-        run: mypy docs tests pandas_dataclasses
-      - name: Test code's execution (pytest)
-        run: pytest -v tests
-      - name: Test docs' building (Sphinx)
-        if: ${{ matrix.python != '3.9' }}
-        run: docs/build
+      - run: uv sync --frozen
+      - run: black --check ${PYTHON_DIRS}
+      - run: pyright ${PYTHON_DIRS}
+      - run: pytest -v
+      - run: docs/build
+        if: ${{ matrix.env != 'python3.9-bookworm' }}

CITATION.cff

@@ -1,15 +1,30 @@
-cff-version: 1.2.0
-message: "If you use this software, please cite it as below."
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
 
-title: "pandas-dataclasses"
-abstract: "pandas data creation made easy by dataclass"
-version: 0.13.0
-date-released: 2024-12-09
-license: "MIT"
-doi: "10.5281/zenodo.6127352"
-url: "https://github.com/astropenguin/pandas-dataclasses"
+cff-version: 1.2.0
+title: pandas-dataclasses
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
 authors:
-  - given-names: "Akio"
-    family-names: "Taniguchi"
-    affiliation: "Nagoya University"
-    orcid: "https://orcid.org/0000-0002-9695-6183"
+  - given-names: Akio
+    family-names: Taniguchi
+    email: taniguchi.akio@gmail.com
+    affiliation: Kitami Institute of Technology
+    orcid: 'https://orcid.org/0000-0002-9695-6183'
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.10652375
+repository-code: 'https://github.com/astropenguin/pandas-dataclasses'
+url: 'https://astropenguin.github.io/pandas-dataclasses/v1.0.0'
+abstract: pandas data creation by data classes
+keywords:
+  - python
+  - dataclasses
+  - pandas
+  - specifications
+  - typing
+license: MIT
+version: 1.0.0
+date-released: '2025-01-01'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2023 Akio Taniguchi
+Copyright (c) 2021-2025 Akio Taniguchi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,7 +6,7 @@
 [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.6127352-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.6127352)
 [![Tests](https://img.shields.io/github/actions/workflow/status/astropenguin/pandas-dataclasses/tests.yml?label=Tests&style=flat-square)](https://github.com/astropenguin/pandas-dataclasses/actions)
 
-pandas data creation made easy by dataclass
+pandas data creation by data classes
 
 ## Overview
 

docs/build

@@ -1,4 +1,4 @@
 #!/bin/bash -eu
 
-sphinx-apidoc -efT -o docs/_apidoc pandas_dataclasses
+sphinx-apidoc -efMT -d 2 -o docs/_apidoc pandas_dataclasses
 sphinx-build -a docs docs/_build

docs/conf.py

@@ -1,10 +1,11 @@
 # project information
 author = "Akio Taniguchi"
-copyright = "2021-2022 Akio Taniguchi"
+copyright = "2021-2025 Akio Taniguchi"
 
 
 # general configuration
 add_module_names = False
+autodoc_member_order = "bysource"
 autodoc_typehints = "both"
 autodoc_typehints_format = "short"
 exclude_patterns = [
@@ -24,13 +25,8 @@
 
 
 # options for HTML output
-html_static_path = ["_static"]
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
-    "logo": {
-        "image_light": "logo-light.svg",
-        "image_dark": "logo-dark.svg",
-    },
-    "github_url": "https://github.com/astropenguin/pandas-dataclasses/",
-    "twitter_url": "https://twitter.com/astropengu_in/",
+    "github_url": "https://github.com/astropenguin/pandas-dataclasses",
+    "logo": {"text": "pandas-dataclasses"},
 }

pandas_dataclasses/__init__.py

@@ -16,7 +16,7 @@
     "core",
     "extras",
 ]
-__version__ = "0.13.0"
+__version__ = "1.0.0"
 
 
 # submodules