Skip to content
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

(Test PR) Fix and simplify dependency groups and extras #1

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ It's essential that we maintain great documentation and testing. If you:
### 🚩GitHub Issues

Our [issues](https://github.com/jflick58/wasm_exec/issues) page is kept up to date
with bugs, improvements, and feature requests.
with bugs, improvements, and feature requests.

If you start working on an issue, please assign it to yourself.

Expand Down Expand Up @@ -58,10 +58,10 @@ This project uses [Poetry](https://python-poetry.org/) as a dependency manager.
To install requirements:

```bash
poetry install -E all
poetry install --all-extras
```

This will install all requirements for running the package, examples, linting, formatting, tests, and coverage. Note the `-E all` flag will install all optional dependencies necessary for integration testing.
This will install all requirements for running the package, examples, linting, formatting, tests, and coverage. Note the `--all-extras` flag will install all optional dependencies necessary for integration testing.

❗Note: If you're running Poetry 1.4.1 and receive a `WheelFileValidationError` for `debugpy` during installation, you can try either downgrading to Poetry 1.4.0 or disabling "modern installation" (`poetry config installer.modern-installation false`) and re-install requirements. See [this `debugpy` issue](https://github.com/microsoft/debugpy/issues/1246) for more details.

Expand Down Expand Up @@ -105,8 +105,6 @@ make coverage

### Testing

Install required dependencies with `poetry install --with test`

#### Unit Tests

Unit tests cover modular logic that does not require calls to outside APIs.
Expand All @@ -123,9 +121,9 @@ If you add new logic, please add a unit test.

### Contribute Documentation

Right now, documentation is via docstrings and the README. In the future we will be adding
Right now, documentation is via docstrings and the README. In the future we will be adding
docs that are autogenerated by [sphinx](https://www.sphinx-doc.org/en/master/), so please follow
the sphinx docstring format.
the sphinx docstring format.

<!-- # Docs are largely autogenerated by [sphinx](https://www.sphinx-doc.org/en/master/) from the code.

Expand Down Expand Up @@ -159,4 +157,4 @@ As of now, wasm_exec has an ad hoc release process: releases are cut with high f
a developer and published to [PyPI](https://pypi.org/project/langchain/).

wasm_exec follows the [semver](https://semver.org/) versioning standard. However, as pre-1.0 software,
even patch releases may contain [non-backwards-compatible changes](https://semver.org/#spec-item-4).
even patch releases may contain [non-backwards-compatible changes](https://semver.org/#spec-item-4).
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
cache: poetry
- name: Install dependencies
run: |
poetry install --with lint
poetry install --only=main,lint
- name: Analysing the code with our lint
run: |
make lint
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ jobs:
install-command: |
if [ "${{ matrix.test_type }}" == "core" ]; then
echo "Running core tests, installing dependencies with poetry..."
poetry install --with test
poetry install --only=main,test
else
echo "Running extended tests, installing dependencies with poetry..."
poetry install -E extended_testing
poetry install --only=main,test --all-extras
fi
- name: Run ${{matrix.test_type}} tests
run: |
Expand Down
Loading