Merge pull request #96 from ipums/v0.5.0-dev

V0.5.0 dev

.github/workflows/coverage.yml

@@ -1,5 +1,9 @@
 name: CodeCov
-on: [push, pull_request]
+on:
+  push:
+    branches: [ master, test_actions ]
+  pull_request:
+    branches: [ master ]
 jobs:
   run_tests:
     runs-on: ubuntu-20.04
@@ -8,10 +12,10 @@ jobs:
       fail-fast: true
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: 3.9
 
@@ -23,7 +27,7 @@ jobs:
           virtualenvs-in-project: true
 
       - name: Load cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         id: cache
         with:
           path: .venv
@@ -41,6 +45,6 @@ jobs:
         run: poetry run py.test --runint --cov=ipumspy --cov-report=xml
 
       - name: Upload Coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v4
         with:
           token: ${{secrets.CODECOV_TOKEN}}

.github/workflows/main.yml

@@ -16,10 +16,10 @@ jobs:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -34,7 +34,7 @@ jobs:
         run: poetry config experimental.new-installer false
 
       - name: Load cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         id: cache
         with:
           path: .venv

README.md

@@ -18,7 +18,7 @@ pip install ipumspy
 
 ## Getting Started
 
-Documentation found [here](https://ipumspy.readthedocs.io/en/latest/index.html).
+Documentation and usage information found [here](https://ipumspy.readthedocs.io/en/latest/index.html).
 
 ## Development
 

docs/source/change-log.rst

@@ -11,6 +11,33 @@ This project adheres to `Semantic Versioning`_.
 .. _Semantic Versioning: http://semver.org/
 
 
+
+0.5.0
+-----
+2024-06-27
+
+* Breaking Changes
+
+  * ``UsaExtract``, ``CpsExtract``, and ``IpumsiExtract`` have been consolidated into a single :py:class:`~ipumspy.api.extract.MicrodataExtract` class that requires an IPUMS collection id as its first positional argument.
+
+* New Features
+
+  * Support for new IPUMS API features added in the `Version 2, May 2024 Update <https://developer.ipums.org/docs/v2/apiprogram/changelog/>`_.
+
+    * Added :py:class:`~ipumspy.api.extract.TimeUseVariable` to support adding IPUMS ATUS, AHTUS, and MTUS time use variables to extracts
+    * ``sample_members`` is now a valid key word argument in :py:class:`~ipumspy.api.extract.MicrodataExtract` for IPUMS ATUS extracts to request non-respondents and household members of respondents be included in an IPUMS ATUS extract
+    * Rectangular on activity (``{"rectangular": {"on": "A"}}``) is now a supported data structure for IPUMS ATUS, AHTUS, and MTUS data collections
+    * Rectangular on round (``{"rectangular": {"on": "R"}}``) is now a supported data structure for IPUMS MEPS
+    * Rectangular on injury (``{"rectangular": {"on": "I"}}``) is now a supported data structure for IPUMS IHIS
+    * Household-only extracts (``{"householdOnly": {}``) is now a supported data structure for IPUMS USA
+
+* Bug Fixes
+
+  * An off-by-one error that was causing variables read using the :py:meth:`~ipumspy.noextract.read_noextract_codebook()` method to be one digit too wide has bee fixed.
+  * :py:meth:`~ipumspy.readers.read_microdata()` and :py:meth:`~ipumspy.readers.read_hierarchical_microdata()` now handle floating point data in IPUMS extract files correctly.
+  * :py:meth:`~ipumspy.api.extract.define_extract_from_json()` and :py:meth:`~ipumspy.api.extract.extract_from_dict()` now correctly read the keyword argument elements of the extract definition dictionaries rather than using default values.
+  * If a list containing both string variable names or time use variable names and :py:class:`~ipumspy.api.Variable` or :py:class:`~ipumspy.api.TimeUseVariable` objects, a TypeError is raised.
+
 0.4.1
 -----
 2023-08-08

docs/source/cli.rst

@@ -24,7 +24,7 @@ as described in the :doc:`getting started guide <getting_started>`.
 
     description: Simple IPUMS extract
     collection: usa
-    api_version: beta
+    api_version: 2
     samples:
       - us2012b
     variables:
@@ -58,7 +58,7 @@ which contains the following:
 
     description: Another extract
     collection: usa
-    api_version: beta
+    api_version: 2
     samples:
       - us2012b
     variables:
@@ -80,15 +80,15 @@ extracts simultaneously. To do so, specify the ``ipums_multiple.yml`` file as fo
     extracts:
     - description: Simple IPUMS extract
       collection: usa
-      api_version: beta
+      api_version: 2
       samples:
         - us2012b
       variables:
         - AGE
         - SEX
     - description: Another extract
       collection: usa
-      api_version: beta
+      api_version: 2
       samples:
         - us2012b
       variables:

docs/source/conf.py

@@ -179,6 +179,7 @@
 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
 copybutton_prompt_is_regexp = True
 
+
 # this is a workaround to filter out forward reference issue in
 # sphinx_autodoc_typehints
 class FilterPandasTypeAnnotationWarning(pylogging.Filter):
@@ -196,6 +197,7 @@ def filter(self, record: pylogging.LogRecord) -> bool:
     FilterPandasTypeAnnotationWarning()
 )
 
+
 # based on pandas/doc/source/conf.py
 def linkcode_resolve(domain, info):
     """Determine the URL corresponding to Python object."""