Use pyproject.toml

Author: rly

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -1 +1 @@
-hdmf_docutils/_version.py export-subst
+.git_archival.txt export-subst

.gitignore

@@ -50,3 +50,7 @@ docs/_build
 # IDE junk
 .idea/*
 *.swp
+
+# Add Hatch
+.hatch/
+.venv/

MAINTAINERS.rst

@@ -1,9 +1,14 @@
 Maintainers: How to make a new release ?
 ----------------------------------------
 
+0. Create a GitHub release and the `publish_pypi.yml` workflow will automatically upload the packages to PyPI.
+
+How to make a manual release?
+-----------------------------
+
 *Fixed font text area below list commands expected to be entered in a bash shell*
 
-1. Configure ``~/.pypirc`` as described `here <https://packaging.python.org/distributing/#uploading-your-project-to-pypi>`_.
+1. Configure ``~/.pypirc`` as described `here <https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-your-project-to-pypi>`_.
 
 2. Make sure the cli and module work as expected.
 
@@ -27,7 +32,8 @@ Maintainers: How to make a new release ?
 ::
 
     rm -rf dist/
-    python setup.py sdist bdist_wheel
+    python -m pip install build
+    python -m build 
 
 6. Upload the packages to the testing PyPI instance:
 

MANIFEST.in

@@ -5,23 +5,39 @@ HDMF Documentation Utilities
 *This project is under active development. Its content, API and behavior may change at any time. We mean it.*
 
 .. image:: https://img.shields.io/pypi/l/hdmf-docutils.svg
-    :target: https://github.com/hdmf-dev/hdmf-docutils/blob/master/license.txt
+    :target: https://github.com/hdmf-dev/hdmf-docutils/blob/main/license.txt
     :alt:    PyPI - License
 
 .. image:: https://img.shields.io/pypi/v/hdmf-docutils.svg
     :target: https://pypi.org/project/hdmf-docutils/
     :alt:    PyPI
 
-.. image:: https://dev.azure.com/hdmf-dev/hdmf-docutils/_apis/build/status/hdmf-dev.hdmf-docutils?branchName=master
-    :target: https://dev.azure.com/hdmf-dev/hdmf-docutils/_build/latest?definitionId=1&branchName=master
-    :alt:    Build Status
+.. image:: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/codespell.yml/badge.svg
+    :target: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/codespell.yml
+    :alt:    Codespell
+
+.. image:: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/doc_builds.yml/badge.svg
+    :target: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/doc_builds.yml
+    :alt:    Doc Builds
+
+.. image:: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/publish_pypi.yml/badge.svg
+    :target: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/publish_pypi.yml
+    :alt:    Publish to PyPI
+
+.. image:: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/ruff.yml/badge.svg
+    :target: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/ruff.yml
+    :alt:    Ruff
+
+.. image:: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/run_all_tests.yml/badge.svg
+    :target: https://github.com/hdmf-dev/hdmf-docutils/actions/workflows/run_all_tests.yml
+    :alt:    Run all tests
 
 Overview
 --------
 
 This project is a collection of CLIs, scripts and modules useful to generate the HDMF documentation.
 
-Using hdmf-docutils to generate documentation for an extension: http://pynwb.readthedocs.io/en/latest/extensions.html#documenting-extensions
+Using hdmf-docutils to generate documentation for an extension: https://nwb-overview.readthedocs.io/en/latest/extensions_tutorial/6_documenting_extension.html
 
 To cite this tool use: (HDMF Documentation Utilities, RRID:SCR_021341)
 

README.rst

@@ -3,7 +3,12 @@
 other utility functions.
 """
 
-from ._version import get_versions
+try:
+    # see https://effigies.gitlab.io/posts/python-packaging-2023/
+    from ._version import __version__
+except ImportError:  # pragma: no cover
+    # this is a relatively slower method for getting the version string
+    from importlib.metadata import version  # noqa: E402
 
-__version__ = get_versions()['version']
-del get_versions
+    __version__ = version("hdmf_docutils")
+    del version