Rename from 'versioned-config' to 'config-versioned', which ACTUALLY avoids a reserved PyPI package name.

Author: njhenry

README.md

@@ -1,22 +1,22 @@
-# versioned-config
+# config-versioned
 
 A Python package for YAML-based configuration management in data pipelines, with versioned directory support and automatic file I/O by extension.
 
 ## Installation
 
 ```bash
-pip install versioned-config
+pip install config-versioned
 ```
 
 Install optional extras for specific file formats:
 
 ```bash
-pip install versioned-config[pandas]   # CSV, TSV, Excel, Stata
-pip install versioned-config[geo]      # Shapefiles, GeoJSON, GeoPackage, etc.
-pip install versioned-config[raster]   # GeoTIFF, rasterio formats
-pip install versioned-config[xarray]   # NetCDF
-pip install versioned-config[dbfread]  # DBF files
-pip install versioned-config[all]      # All of the above
+pip install config-versioned[pandas]   # CSV, TSV, Excel, Stata
+pip install config-versioned[geo]      # Shapefiles, GeoJSON, GeoPackage, etc.
+pip install config-versioned[raster]   # GeoTIFF, rasterio formats
+pip install config-versioned[xarray]   # NetCDF
+pip install config-versioned[dbfread]  # DBF files
+pip install config-versioned[all]      # All of the above
 ```
 
 ## Quick Start
@@ -48,7 +48,7 @@ versions:
 ### 2. Load the config
 
 ```python
-from versioned_config import Config
+from config_versioned import Config
 
 cfg = Config('project_config.yaml')
 ```
@@ -110,7 +110,7 @@ cfg_v2.get_dir_path('results')  # ~/data/results/v2
 ## Standalone autoread / autowrite
 
 ```python
-from versioned_config import autoread, autowrite
+from config_versioned import autoread, autowrite
 
 # Read by extension
 df = autoread('data/records.csv')
@@ -145,8 +145,8 @@ A bundled example is included with the package:
 
 ```python
 import importlib.resources as r
-from versioned_config import Config
+from config_versioned import Config
 
-path = str(r.files("versioned_config") / "data" / "example_config.yaml")
+path = str(r.files("config_versioned") / "data" / "example_config.yaml")
 cfg = Config(path)
 ```

docs/api.rst

@@ -4,25 +4,25 @@ API Reference
 Config
 ------
 
-.. autoclass:: versioned_config.Config
+.. autoclass:: config_versioned.Config
    :members:
    :special-members: __init__, __repr__
 
 File I/O
 --------
 
-.. autofunction:: versioned_config.autoread
+.. autofunction:: config_versioned.autoread
 
-.. autofunction:: versioned_config.autowrite
+.. autofunction:: config_versioned.autowrite
 
 Format Registries
 -----------------
 
-.. autofunction:: versioned_config.get_file_reading_functions
+.. autofunction:: config_versioned.get_file_reading_functions
 
-.. autofunction:: versioned_config.get_file_writing_functions
+.. autofunction:: config_versioned.get_file_writing_functions
 
 Utilities
 ---------
 
-.. autofunction:: versioned_config.pull_from_config
+.. autofunction:: config_versioned.pull_from_config

docs/conf.py

@@ -8,7 +8,7 @@
 
 # -- Project information -----------------------------------------------------
 
-from versioned_config import __version__
+from config_versioned import __version__
 
 project = "versioning"
 copyright = "2026, Nathaniel Henry"

docs/getting_started.rst

@@ -1,14 +1,14 @@
 Getting Started
 ===============
 
-This guide introduces the **versioned-config** package, which simplifies management of
-project settings and file I/O by combining them in a single :class:`~versioned_config.Config`
+This guide introduces the **config-versioned** package, which simplifies management of
+project settings and file I/O by combining them in a single :class:`~config_versioned.Config`
 object.
 
 Data pipelines commonly require reading and writing data to versioned directories. Each
 directory might correspond to one step of a multi-step process, where the version
 corresponds to particular settings for that step and a chain of prior steps that each
-have their own respective versions. The :class:`~versioned_config.Config` class makes it easy
+have their own respective versions. The :class:`~config_versioned.Config` class makes it easy
 to read and write versioned data based on YAML configuration files that can be saved
 alongside each versioned output folder.
 
@@ -22,9 +22,9 @@ string, and boolean settings as well as hierarchically nested values. The
 .. code-block:: python
 
     import importlib.resources as r
-    from versioned_config import Config
+    from config_versioned import Config
 
-    example_config_path = str(r.files("versioned_config") / "data" / "example_config.yaml")
+    example_config_path = str(r.files("config_versioned") / "data" / "example_config.yaml")
 
 The example YAML file looks like this:
 
@@ -50,7 +50,7 @@ The example YAML file looks like this:
     versions:
       prepared_data: 'v1'
 
-Create a :class:`~versioned_config.Config` object by passing either a path to a YAML file
+Create a :class:`~config_versioned.Config` object by passing either a path to a YAML file
 or a plain Python dict. The full config is stored in the ``config`` attribute:
 
 .. code-block:: python
@@ -62,7 +62,7 @@ Retrieving settings
 -------------------
 
 You can access the config dict directly (``config.config["a"]``), but
-:meth:`~versioned_config.Config.get` is preferable — it raises a clear ``KeyError`` if a
+:meth:`~config_versioned.Config.get` is preferable — it raises a clear ``KeyError`` if a
 setting is missing rather than returning ``None`` silently:
 
 .. code-block:: python
@@ -85,7 +85,7 @@ Working with directories
 ------------------------
 
 Two top-level keys — ``directories`` and ``versions`` — give the
-:class:`~versioned_config.Config` object its versioning capability. Each entry under
+:class:`~config_versioned.Config` object its versioning capability. Each entry under
 ``directories`` must have:
 
 - **versioned** (bool) — whether the directory has version subdirectories
@@ -96,8 +96,8 @@ For **versioned** directories the full path is ``{path}/{version}``, where the v
 string comes from the ``versions`` dict. For **non-versioned** directories the full
 path is just ``path``.
 
-Use :meth:`~versioned_config.Config.get_dir_path` and
-:meth:`~versioned_config.Config.get_file_path` to build these paths:
+Use :meth:`~config_versioned.Config.get_dir_path` and
+:meth:`~config_versioned.Config.get_file_path` to build these paths:
 
 .. code-block:: python
 
@@ -136,13 +136,13 @@ Reading and writing files
 -------------------------
 
 Copy the bundled example CSV into the raw data directory, then use
-:meth:`~versioned_config.Config.read` and :meth:`~versioned_config.Config.write` to move data
+:meth:`~config_versioned.Config.read` and :meth:`~config_versioned.Config.write` to move data
 through the pipeline:
 
 .. code-block:: python
 
     # Copy the example input file into the raw_data directory
-    example_csv = str(r.files("versioned_config") / "data" / "example_input_file.csv")
+    example_csv = str(r.files("config_versioned") / "data" / "example_input_file.csv")
     shutil.copy(example_csv, config.get_file_path("raw_data", "a"))
 
     # Read the CSV (returns a pandas DataFrame)
@@ -159,21 +159,21 @@ through the pipeline:
     # Both files now appear in the versioned directory
     list(config.get_dir_path("prepared_data").iterdir())
 
-These methods delegate to :func:`~versioned_config.autoread` and
-:func:`~versioned_config.autowrite`, which dispatch on file extension. To see every
+These methods delegate to :func:`~config_versioned.autoread` and
+:func:`~config_versioned.autowrite`, which dispatch on file extension. To see every
 supported extension:
 
 .. code-block:: python
 
-    from versioned_config import get_file_reading_functions, get_file_writing_functions
+    from config_versioned import get_file_reading_functions, get_file_writing_functions
 
     sorted(get_file_reading_functions().keys())
     sorted(get_file_writing_functions().keys())
 
 Saving the config alongside outputs
 ------------------------------------
 
-:meth:`~versioned_config.Config.write_self` writes the current config dict as
+:meth:`~config_versioned.Config.write_self` writes the current config dict as
 ``config.yaml`` into a named directory. This is useful for reproducibility — you can
 always see exactly which settings produced a given set of outputs:
 
@@ -188,7 +188,7 @@ Overriding versions at runtime
 -------------------------------
 
 Rather than editing the YAML file between runs, you can pass a ``versions`` dict when
-constructing a :class:`~versioned_config.Config` object. This sets or overwrites the
+constructing a :class:`~config_versioned.Config` object. This sets or overwrites the
 specified versions while leaving all other settings unchanged — useful for command-line
 scripts or automated pipelines:
 

docs/index.rst

@@ -6,17 +6,17 @@ automatic file I/O by extension.
 
 .. code-block:: bash
 
-   pip install versioned-config
+   pip install config-versioned
 
 **Quick example:**
 
 .. code-block:: python
 
    import importlib.resources as r
-   from versioned_config import Config
+   from config_versioned import Config
 
    # Load the bundled example config
-   path = str(r.files("versioned_config") / "data" / "example_config.yaml")
+   path = str(r.files("config_versioned") / "data" / "example_config.yaml")
    cfg = Config(path)
 
    # Retrieve settings (top-level and nested)

docs/installation.rst

@@ -5,18 +5,18 @@ Core package (YAML support only):
 
 .. code-block:: bash
 
-   pip install versioned-config
+   pip install config-versioned
 
 With optional file-format extras:
 
 .. code-block:: bash
 
-   pip install versioned-config[pandas]    # CSV, TSV, Excel, Stata
-   pip install versioned-config[geo]       # Shapefiles, GeoJSON, GeoPackage, etc.
-   pip install versioned-config[raster]    # GeoTIFF and other raster formats
-   pip install versioned-config[xarray]    # NetCDF
-   pip install versioned-config[dbfread]   # DBF files
-   pip install versioned-config[all]       # All of the above
+   pip install config-versioned[pandas]    # CSV, TSV, Excel, Stata
+   pip install config-versioned[geo]       # Shapefiles, GeoJSON, GeoPackage, etc.
+   pip install config-versioned[raster]    # GeoTIFF and other raster formats
+   pip install config-versioned[xarray]    # NetCDF
+   pip install config-versioned[dbfread]   # DBF files
+   pip install config-versioned[all]       # All of the above
 
 Config file structure
 ---------------------
@@ -92,7 +92,7 @@ Supported file extensions
      - nc
      - ``xarray``
 
-For raster files, :func:`~versioned_config.autoread` returns
+For raster files, :func:`~config_versioned.autoread` returns
 ``{"data": np.ndarray, "profile": dict}`` and
-:func:`~versioned_config.autowrite` accepts that same structure (or a
+:func:`~config_versioned.autowrite` accepts that same structure (or a
 ``(data, profile)`` tuple).

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=68", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "versioned-config"
+name = "config-versioned"
 version = "0.2.0"
 description = "Settings and file I/O management using a configuration YAML file"
 readme = "README.md"
@@ -54,7 +54,7 @@ dev = [
 where = ["src"]
 
 [tool.setuptools.package-data]
-"versioned_config" = ["data/*.yaml", "data/*.csv"]
+"config_versioned" = ["data/*.yaml", "data/*.csv"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

src/config_versioned/__init__.py

@@ -0,0 +1,17 @@
+"""config_versioned: YAML-based config management for versioned data pipelines."""
+
+__version__ = "0.2.0"
+
+from config_versioned.config import Config
+from config_versioned.autoread import autoread, get_file_reading_functions
+from config_versioned.autowrite import autowrite, get_file_writing_functions
+from config_versioned.utilities import pull_from_config
+
+__all__ = [
+    "Config",
+    "autoread",
+    "autowrite",
+    "pull_from_config",
+    "get_file_reading_functions",
+    "get_file_writing_functions",
+]

src/versioned_config/autoread.py src/config_versioned/autoread.pysrc/versioned_config/autoread.py renamed to src/config_versioned/autoread.py

@@ -3,7 +3,7 @@
 import os
 from pathlib import Path
 
-from versioned_config.utilities import pull_from_config
+from config_versioned.utilities import pull_from_config
 
 
 def _require_or_raise(pkg_name, install_extra=None):

src/versioned_config/autowrite.py src/config_versioned/autowrite.pysrc/versioned_config/autowrite.py renamed to src/config_versioned/autowrite.py

@@ -3,7 +3,7 @@
 import os
 from pathlib import Path
 
-from versioned_config.autoread import _require_or_raise
+from config_versioned.autoread import _require_or_raise
 
 
 def get_file_writing_functions():