Merge pull request #123 from palewire/ruff

Switch to Ruff formatting and linting

.github/workflows/continuous-deployment.yml

@@ -13,26 +13,13 @@ jobs:
     name: Lint Python code
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - id: checkout
+        name: Checkout
         uses: actions/checkout@v4
 
-      - id: install-python
-        name: Install Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.11'
-          cache: 'pipenv'
-
-      - name: Install pipenv
-        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
-
-      - id: install-python-dependencies
-        name: Install Python dependencies
-        run: pipenv install --dev --python `which python`
-
-      - id: lint
-        name: Lint Python code
-        run: pipenv run flake8 ./ --verbose
+      - id: ruff
+        name: Ruff
+        uses: chartboost/ruff-action@v1
 
   test-python:
     strategy:

.gitignore

@@ -13,3 +13,4 @@ build
 *.*#
 .ipynb_checkpoints
 todo
+.ruff-cache

.pre-commit-config.yaml

@@ -15,31 +15,20 @@ repos:
     -   id: check-ast
     -   id: check-merge-conflict
 
--   repo: https://github.com/psf/black
-    rev: 23.3.0
+-   repo: 'https://github.com/astral-sh/ruff-pre-commit'
+    rev: v0.6.3
     hooks:
-    -   id: black
+    -   id: ruff
+        args:
+        -   '--fix'
+    -   id: ruff-format
 
 -   repo: https://github.com/asottile/blacken-docs
     rev: 1.16.0
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black]
 
--   repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        args: ["--profile", "black", "--filter-files"]
-
--   repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
-    hooks:
-    - id: flake8
-      additional_dependencies:
-        - flake8-bugbear
-        # - flake8-docstrings
-
 -   repo: https://github.com/asottile/pyupgrade
     rev: v3.15.0
     hooks:

README.md

@@ -1,7 +1,7 @@
 ### Links
 
 * Docs: [palewi.re/docs/cpi/](https://palewi.re/docs/cpi/)
-* Code: [github.com/datadesk/cpi](https://github.com/datadesk/cpi/)
-* Issues: [github.com/datadesk/cpi/issues](https://github.com/datadesk/cpi/issues)
+* Code: [github.com/palewire/cpi](https://github.com/palewire/cpi/)
+* Issues: [github.com/palewire/cpi/issues](https://github.com/palewire/cpi/issues)
 * Packaging: [pypi.python.org/pypi/cpi](https://pypi.python.org/pypi/cpi)
-* Testing: [github.com/datadesk/cpi/actions](https://github.com/datadesk/cpi/actions)
+* Testing: [github.com/palewire/cpi/actions](https://github.com/palewire/cpi/actions)

cpi/__init__.py

@@ -2,6 +2,7 @@
 """
 Quickly adjust U.S. dollars for inflation using the Consumer Price Index (CPI)
 """
+
 import logging
 import numbers
 import warnings

cpi/cli.py

@@ -2,6 +2,7 @@
 """
 Command-line interface.
 """
+
 import click
 from dateutil.parser import parse as dateparse
 

cpi/defaults.py

@@ -2,6 +2,7 @@
 """
 Default values.
 """
+
 DEFAULT_SERIES_ID = "CUUR0000SA0"
 DEFAULTS_SERIES_ATTRS = {
     "survey": "All urban consumers",

cpi/download.py

@@ -1,4 +1,5 @@
 """Download the latest annual Consumer Price Index (CPI) dataset."""
+
 import io
 import logging
 import sqlite3

cpi/models.py

@@ -1,4 +1,5 @@
 """Python objects for modeling Consumer Price Index (CPI) data structures."""
+
 from __future__ import annotations
 
 import logging

cpi/parsers.py

@@ -2,6 +2,7 @@
 """
 Parse and prepare the Consumer Price Index (CPI) dataset.
 """
+
 import logging
 import os
 import sqlite3

docs/conf.py

@@ -1,6 +1,8 @@
 """Configure Sphinx configuration."""
+
 import os
 import sys
+from typing import Any
 from datetime import datetime
 
 # Insert the parent directory into the path
@@ -21,8 +23,8 @@
 exclude_patterns = ["_build"]
 
 html_theme = "palewire"
-html_sidebars = {}
-html_theme_options = {
+html_sidebars: dict[Any, Any] = {}
+html_theme_options: dict[str, Any] = {
     "canonical_url": f"https://palewi.re/docs/{project}/",
     "nosidebar": True,
 }

docs/index.md

@@ -46,13 +46,19 @@ cpi.inflate(100, date(1950, 1, 1), to=date(2018, 1, 1))
 
 You can adjust values using any of the other series published by the BLS as part of its "All Urban Consumers (CU)" survey. They offer more precise measures for different regions and items.
 
-Submit one of the 60 areas tracked by the agency to inflate dollars in that region. You can find a complete list in [the repository](https://github.com/palewire/cpi/blob/main/data/areas.csv).
+Submit one of the 60 areas tracked by the agency to inflate dollars in that region.
 
 ```python
 cpi.inflate(100, 1950, area="Los Angeles-Long Beach-Anaheim, CA")
 1081.054852320675
 ```
 
+You can find a complete list in [the repository](https://github.com/palewire/cpi/blob/main/data/areas.csv) or by running the following command:
+
+```python
+cpi.areas.all()
+```
+
 You can do the same to inflate the price of 400 specific items lumped into the basket of goods that make up the overall index.  You can find a complete list in [the repository](https://github.com/palewire/cpi/blob/main/data/items.csv).
 
 ```python
@@ -177,7 +183,7 @@ Options:
 
 The lists of CPI series and each's index values can be converted to a DataFrame using the `to_dataframe` method.
 
-Here's how to get the series list:
+Here's how to get the list of series you've loaded thus far:
 
 ```python
 series_df = cpi.series.to_dataframe()
@@ -206,7 +212,7 @@ cpi.update()
 
 ## Other resources
 
-* Code: [github.com/datadesk/cpi](https://github.com/datadesk/cpi/)
-* Issues: [github.com/datadesk/cpi/issues](https://github.com/datadesk/cpi/issues)
+* Code: [github.com/palewire/cpi](https://github.com/palewire/cpi/)
+* Issues: [github.com/palewire/cpi/issues](https://github.com/palewire/cpi/issues)
 * Packaging: [pypi.python.org/pypi/cpi](https://pypi.python.org/pypi/cpi)
-* Testing: [github.com/datadesk/cpi/actions](https://github.com/datadesk/cpi/actions)
+* Testing: [github.com/palewire/cpi/actions](https://github.com/palewire/cpi/actions)