Skip to content

Add optional support for venv + pip install -e workflow (Fixes #6)#7

Open
AdityaGupta716 wants to merge 2 commits intoOpenScienceLabs:mainfrom
AdityaGupta716:feature/pip-venv-support
Open

Add optional support for venv + pip install -e workflow (Fixes #6)#7
AdityaGupta716 wants to merge 2 commits intoOpenScienceLabs:mainfrom
AdityaGupta716:feature/pip-venv-support

Conversation

@AdityaGupta716
Copy link

Description

This PR addresses Issue #6 by adding optional support for the standard Python venv + pip install -e workflow as an alternative to the existing uv-based installation.

Changes Made

1. Extended pyproject.toml

  • Added proper [build-system] configuration with setuptools backend
  • Configured package metadata and dependencies
  • Added [tool.setuptools] configuration to support editable installations
  • Included [tool.setuptools.package-data] for proper data file handling (CSV, JSON, YAML files)

2. Updated README.md

  • Added new "Alternative: Using Standard Python venv + pip (Optional)" section
  • Provided step-by-step instructions for non-uv installation workflow
  • Clarified that both installation methods work side-by-side without conflicts

Why This Change?

This change improves accessibility for contributors who:

  • Prefer standard Python tools without additional package managers
  • Work in environments where uv might not be convenient
  • Want to use the project in development/editable mode

Backward Compatibility

✅ Fully backward compatible - existing uv workflow remains unchanged and fully functional. Both methods coexist seamlessly.

Testing

The changes have been validated to ensure:

  • The existing uv installation workflow continues to work
  • New pip install -e . workflow functions correctly
  • Data files are properly included in the package
  • No conflicts between the two installation methods

…ceLabs#6)

- Extended pyproject.toml with setuptools build-system configuration
- Added package-data configuration for data files (CSV, JSON, YAML)
- Allows standard Python venv + pip install -e . workflow alongside existing uv setup
- Maintains backward compatibility with uv.lock and existing installation method
- Improves maintainability and accessibility for contributors
- Added comprehensive instructions for standard Python venv + pip installation
- Provides step-by-step guide for contributors preferring non-uv workflows
- Clarifies that both methods work side-by-side without conflicts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant