Skip to content

feat: Update project build and configuration #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 29, 2025

Conversation

pbadillatorrealba
Copy link
Member

@pbadillatorrealba pbadillatorrealba commented Jul 29, 2025

This pull request introduces several updates to the WEFE project, focusing on modernizing the codebase, improving documentation, updating dependencies, and enhancing the development workflow. Key changes include migrating to Python 3.10, updating the licensing year, refining installation instructions, and improving benchmark documentation.

Dependency and Configuration Updates:

  • Dropped .flake8 configuration, signaling a migration to Ruff for linting and formatting.
  • Updated Ruff linter version in .pre-commit-config.yaml from v0.12.3 to v0.12.5.
  • Upgraded Python version in .readthedocs.yaml to 3.12 and streamlined dependency installation with extra_requirements.

Documentation Enhancements:

  • Expanded README.rst with detailed installation options, updated dependency requirements, and improved contributing guidelines. Added instructions for testing, coverage, and building documentation.
  • Refined benchmark documentation (docs/benchmark/benchmark.rst) with updated metric compatibility tables and clarified extensibility details. [1] [2]

Licensing and Packaging:

  • Updated the year in the LICENSE file to 2025.
  • Removed requirements.txt and dataset inclusions from MANIFEST.in, reflecting a shift to modern packaging practices.

These changes collectively modernize the WEFE project, enhance usability, and align it with contemporary Python development standards.

@pbadillatorrealba pbadillatorrealba self-assigned this Jul 29, 2025
@pbadillatorrealba pbadillatorrealba added the enhancement New feature or request label Jul 29, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This is a major release modernizing the WEFE (Word Embedding Fairness Evaluation) framework to version 1.0.0, migrating from Python 3.6-3.9 to Python 3.10+ with significant infrastructure updates.

  • Migration from setup.py to modern pyproject.toml packaging configuration
  • Adoption of Python 3.10+ syntax features including union type operators (|) and strict parameter in zip() calls
  • Complete replacement of deprecated pkg_resources with modern importlib.resources for package data access

Reviewed Changes

Copilot reviewed 45 out of 46 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
pyproject.toml New modern packaging configuration replacing setup.py with dynamic versioning and development dependencies
wefe/word_embedding_model.py Updated type annotations to use union operators and improved import ordering
wefe/utils.py Modernized resource loading using importlib.resources and updated type hints
wefe/query.py Applied union type syntax and added strict=False to zip calls for compatibility
wefe/preprocessing.py Updated type annotations throughout preprocessing functions and utilities
Multiple metric files Consistent updates to type annotations using modern union syntax
Multiple debias files Updated type annotations and improved import organization
tests/ Converted to modern pytest patterns and updated type checks
docs/ Modernized Sphinx configuration and updated benchmark tables

@pbadillatorrealba pbadillatorrealba merged commit 3905f96 into develop Jul 29, 2025
4 checks passed
@pbadillatorrealba pbadillatorrealba deleted the feature/to_pyproject branch July 29, 2025 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant