📚 update project meta data

Author: chfw

.github/workflows/lint.yml

@@ -11,10 +11,10 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
-            python-version: 3.8
+            python-version: 3.11
       - name: lint
         run: |
-          pip install flake8
-          pip install -r tests/requirements.txt
+          pip --use-deprecated=legacy-resolver install flake8
+          pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
           flake8 --exclude=.moban.d,docs,setup.py --builtins=unicode,xrange,long . 
           python setup.py checkdocs

.github/workflows/moban-update.yml

@@ -8,22 +8,22 @@ jobs:
       - uses: actions/checkout@v2
         with:
           ref: ${{ github.head_ref }}
+          token: ${{ secrets.PAT }}
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
-          python-version: '3.7'
+          python-version: '3.11'
       - name: check changes
         run: |
-          pip install moban gitfs2 pypifs moban-jinja2-github moban-ansible
+          pip install markupsafe==2.0.1
+          pip install ruamel.yaml moban gitfs2 pypifs moban-jinja2-github moban-ansible
           moban
           git status
           git diff --exit-code
       - name: Auto-commit
         if: failure()
-        uses: docker://cdssnc/auto-commit-github-action
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: stefanzweifel/git-auto-commit-action@v4
         with:
-          args: >-
+          commit_message: >-
             This is an auto-commit, updating project meta data,
             such as changelog.rst, contributors.rst

.github/workflows/pythonpublish.yml

@@ -5,9 +5,16 @@ on:
     types: [created]
 
 jobs:
-  deploy:
+  pypi-publish:
+    name: upload release to PyPI
     runs-on: ubuntu-latest
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: pypi
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
     steps:
+      # retrieve your distributions here
       - uses: actions/checkout@v1
       - name: Set up Python
         uses: actions/setup-python@v1
@@ -16,11 +23,9 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools wheel twine
-      - name: Build and publish
-        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+          pip install setuptools wheel
+      - name: Build
         run: |
           python setup.py sdist bdist_wheel
-          twine upload dist/*
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/tests.yml

@@ -1,27 +1,31 @@
-name: run_tests
+name: Run unit tests on Windows, Ubuntu and Mac
 
 on: [push, pull_request]
 
 jobs:
+
   test:
+    name:  ${{ matrix.os }} / ${{ matrix.python_version }}
+    runs-on: ${{ matrix.os }}-latest 
     strategy:
-        fail-fast: false
-        matrix:
-            python-version: [3.6, 3.7, 3.8, 3.9]
-            os: [macOs-latest, ubuntu-latest, windows-latest]
+      fail-fast: false
+      matrix:
+        os: [Ubuntu]
+        python_version: ["3.9.16"]
 
-    runs-on:  ${{ matrix.os }}
-    name: run tests
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
-            python-version:  ${{ matrix.python-version }}
+            python-version:  ${{ matrix.python_version }}
+            architecture: x64
+
       - name: install
         run: |
-          pip install -r requirements.txt
-          pip install -r tests/requirements.txt
+          pip --use-deprecated=legacy-resolver install -r requirements.txt
+          pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
+          pip --use-deprecated=legacy-resolver install -r rnd_requirements.txt          
       - name: test
         run: |
           pip freeze

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2020 by Onni Software Ltd. and its contributors
+Copyright (c) 2015-2025 by Onni Software Ltd. and its contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms of the software as well
@@ -13,7 +13,7 @@ that the following conditions are met:
   and/or other materials provided with the distribution.
 
 * Neither the name of 'pyexcel-xlsxw' nor the names of the contributors
-  may not be used to endorse or promote products derived from this software
+  may be used to endorse or promote products derived from this software
   without specific prior written permission.
 
 THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND

README.rst

@@ -8,16 +8,14 @@ pyexcel-xlsxw - Let you focus on data, instead of xlsx format
 .. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg
    :target: https://awesome-python.com/#specific-formats-processing
 
-.. image:: https://github.com/pyexcel/pyexcel-xlsxw/workflows/run_tests/badge.svg
-   :target: http://github.com/pyexcel/pyexcel-xlsxw/actions
-
 .. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsxw/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pyexcel/pyexcel-xlsxw
 
 .. image:: https://badge.fury.io/py/pyexcel-xlsxw.svg
    :target: https://pypi.org/project/pyexcel-xlsxw
 
 
+
 .. image:: https://pepy.tech/badge/pyexcel-xlsxw/month
    :target: https://pepy.tech/project/pyexcel-xlsxw
 
@@ -38,19 +36,11 @@ pyexcel-xlsxw - Let you focus on data, instead of xlsx format
 Support the project
 ================================================================================
 
-If your company has embedded pyexcel and its components into a revenue generating
-product, please support me on github, `patreon <https://www.patreon.com/bePatron?u=5537627>`_
-or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain
-the project and develop it further.
-
-If you are an individual, you are welcome to support me too and for however long
-you feel like. As my backer, you will receive
-`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
-
-And your issues will get prioritized if you would like to become my patreon as `pyexcel pro user`.
-
-With your financial support, I will be able to invest
-a little bit more time in coding, documentation and writing interesting posts.
+If your company uses pyexcel and its components in a revenue-generating product,
+please consider supporting the project on GitHub or
+`Patreon <https://www.patreon.com/bePatron?u=5537627>`_. Your financial
+support will enable me to dedicate more time to coding, improving documentation,
+and creating engaging content.
 
 
 Known constraints
@@ -90,15 +80,8 @@ As a standalone library
 
     >>> import os
     >>> import sys
-    >>> if sys.version_info[0] < 3:
-    ...     from StringIO import StringIO
-    ... else:
-    ...     from io import BytesIO as StringIO
-    >>> PY2 = sys.version_info[0] == 2
-    >>> if PY2 and sys.version_info[1] < 7:
-    ...      from ordereddict import OrderedDict
-    ... else:
-    ...     from collections import OrderedDict
+    >>> from io import BytesIO
+    >>> from collections import OrderedDict
 
 
 Write to an xlsx file
@@ -140,7 +123,7 @@ Here's the sample code to write a dictionary to an xlsx file:
     >>> data = OrderedDict()
     >>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
     >>> data.update({"Sheet 2": [[7, 8, 9], [10, 11, 12]]})
-    >>> io = StringIO()
+    >>> io = BytesIO()
     >>> save_data(io, data)
     >>> # do something with the io
     >>> # In reality, you might give it to your http response
@@ -200,18 +183,18 @@ Here is the sample code:
     >>> sheet.save_as("another_file.xlsx")
 
 
-Writing to a StringIO instance
+Writing to a BytesIO instance
 ********************************************************************************
 
-You need to pass a StringIO instance to Writer:
+You need to pass a BytesIO instance to Writer:
 
 .. code-block:: python
 
     >>> data = [
     ...     [1, 2, 3],
     ...     [4, 5, 6]
     ... ]
-    >>> io = StringIO()
+    >>> io = BytesIO()
     >>> sheet = pe.Sheet(data)
     >>> io = sheet.save_to_memory("xlsx", io)
     >>> # then do something with io
@@ -243,26 +226,29 @@ Then install relevant development requirements:
 #. pip install -r tests/requirements.txt
 
 Once you have finished your changes, please provide test case(s), relevant documentation
-and update CHANGELOG.rst.
+and update changelog.yml
 
 .. note::
 
     As to rnd_requirements.txt, usually, it is created when a dependent
-    library is not released. Once the dependecy is installed
+    library is not released. Once the dependency is installed
     (will be released), the future
     version of the dependency in the requirements.txt will be valid.
 
 
 How to test your contribution
-------------------------------
+--------------------------------------------------------------------------------
 
-Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
+Although `nose` and `doctest` are both used in code testing, it is advisable
+that unit tests are put in tests. `doctest` is incorporated only to make sure
+the code examples in documentation remain valid across different development
+releases.
 
 On Linux/Unix systems, please launch your tests like this::
 
     $ make
 
-On Windows systems, please issue this command::
+On Windows, please issue this command::
 
     > test.bat
 
@@ -274,7 +260,7 @@ Please run::
 
     $ make format
 
-so as to beautify your code otherwise travis-ci may fail your unit test.
+so as to beautify your code otherwise your build may fail your unit test.
 
 
 

docs/source/conf.py

@@ -22,7 +22,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pyexcel-xlsxw'
-copyright = '2015-2020 Onni Software Ltd.'
+copyright = '2015-2025 Onni Software Ltd.'
 author = 'C.W.'
 # The short X.Y version
 version = '0.6.1'
@@ -57,7 +57,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -68,7 +68,8 @@
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/3/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3',
+                                  'python-inv.txt')}
 # TODO: html_theme not configurable upstream
 html_theme = 'default'