Merge pull request #2 from andrea-cap/release/0.2.2

release/0.2.2 → master

Author: andrea-cap

.bumpversion.cfg

@@ -8,8 +8,8 @@ indent_style = space
 indent_size = 2
 end_of_line = lf
 charset = utf-8
-trim_trailing_whitespace = false
-insert_final_newline = false
+trim_trailing_whitespace = true
+insert_final_newline = true
 
 [*.py]
-indent_size = 4
+indent_size = 4

.editorconfig

@@ -1,6 +1,3 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: Python application
 
 on:
@@ -18,23 +15,20 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]
-        poetry-version: ["latest", "main"]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install poetry
-      uses: abatilo/actions-poetry@v2
-    - uses: actions/cache@v3
-      name: Define a cache for the virtual environment based on the dependencies lock file
+    - name: Install uv
+      uses: astral-sh/setup-uv@v9
       with:
-        path: ./.venv
-        key: venv-${{ hashFiles('poetry.lock') }}
+        enable-cache: true
     - name: Install project dependencies
-      run: poetry install
+      run: uv sync --locked
+    - name: Check formatting and lint
+      run: uv run ruff check . && uv run ruff format --check .
     - name: Run tests
-      run: poetry run pytest ./tests/
-      
+      run: uv run pytest ./tests/

.github/workflows/python-app.yml

@@ -1,5 +1,26 @@
 # Changelog
 
+## v0.2.2 (2026-08-10)
+
+### New
+
+* Tests added/improved, added normalization of html parsing. [andrea]
+
+### Changes
+
+* New url for checking api errors. [andrea]
+
+* Updated README. [andrea]
+
+* Improved docstring. [andrea]
+
+* Update rules. [andrea]
+
+* Migration from poetry/black to uv/ruff, removed sphinx, other changes. [andrea]
+
+### Fix
+
+* Restored pystache for changelog. [andrea]
 
 ## v0.2.0 (2024-11-06)
 

CHANGELOG.md

@@ -1,42 +1,99 @@
 # PyRepec
 
-![PyPI - Downloads](https://img.shields.io/pypi/dm/pyrepec)
+[![PyPI downloads](https://img.shields.io/pypi/dm/pyrepec)](https://pypi.org/project/pyrepec/)
+[![Python versions](https://img.shields.io/pypi/pyversions/pyrepec)](https://pypi.org/project/pyrepec/)
 
+PyRepec is a small Python client for the [RePEc API](https://ideas.repec.org/api.html).
+It provides typed result models, basic in-session caching, and helpers for querying
+authors, publications, bibliographic references, and JEL codes.
 
-A python client for [RePEc API](https://ideas.repec.org/api.html).
+Current Version: 0.2.2
 
-Current Version: 0.2.1
+## Requirements
 
-Report any bugs by opening an issue here: (https://github.com/TBD)
+- Python 3.9 or newer
+- A RePEc API token
 
+## Installation
 
-### Usage
+Install the package from PyPI:
+
+```bash
+pip install pyrepec
+```
+
+## Quick start
+
+Keep the API token outside your source code, for example in the
+`REPEC_TOKEN` environment variable:
+
+```bash
+export REPEC_TOKEN="your-token"
+```
+
+Create a client and perform a request:
 
 ```python
+import os
+
 from pyrepec import Repec
 
-repec = Repec("TOKEN")
+repec = Repec(os.environ["REPEC_TOKEN"])
+result = repec.get_org_authors("RePEc:edi:bdigvit")
 
-res = repec.get_org_authors("RePEc:edi:bdigvit")
+if result.error is not None:
+    print(f"RePEc error {result.error.code}: {result.error.message}")
+else:
+    for author in result.data:
+        print(author)
 ```
 
+Successful responses expose their payload through `result.data`. Errors reported
+by RePEc are available through `result.error`; in that case, `result.data` is
+empty. HTTP errors are raised by `requests` in the usual way.
 
-### Installation
+## Available methods
 
-1. Installation using pip:
+| Method | Description | Result type |
+| --- | --- | --- |
+| `get_org_authors(org_id)` | Get the authors associated with an organization. | `RepecResultList` |
+| `get_author_data(author_id)` | Get the full record for an author. | `RepecSingleResult` |
+| `get_authors_for_item(item_id)` | Get the authors of a paper or article. | `RepecResultList` |
+| `get_jel_codes(item_id)` | Get the JEL codes associated with an item. | `RepecJelResult` |
+| `get_ref(item_id)` | Get the bibliographic references for an item. | `RepecSingleResult` |
+| `get_error(err_code)` | Resolve a RePEc error code into its function and description. | `tuple[str, str]` |
+
+The exact dictionaries returned in `data` follow the upstream RePEc API response
+format.
+
+## Development
+
+Clone the repository and install the locked development environment:
 
 ```bash
-pip install pyrepec
+git clone https://github.com/andrea-cap/pyrepec.git
+cd pyrepec
+uv sync --locked
 ```
 
+Run the test suite and code-quality checks:
 
-### Methods
+```bash
+uv run pytest ./tests/
+uv run ruff check .
+uv run ruff format --check .
+```
+
+Integration tests require `REPEC_TOKEN`; without it, they are skipped. Unit tests
+do not make external API calls.
+
+Generate the changelog from the available Git history:
+
+```bash
+uv run gitchangelog
+```
 
-Featured methods:
+## Reporting issues
 
-- get_org_authors(org_id: str)
-- get_author_data(author_id: str)
-- get_authors_for_item(item_id: str)
-- get_jel_codes(item_id: str)
-- get_error(err_code: int)
-- get_ref(item_id: str)
+Report bugs and request features through the
+[GitHub issue tracker](https://github.com/andrea-cap/pyrepec/issues).