Skip to content

docs: add local test data setup step#523

Open
samay2504 wants to merge 1 commit into
pysal:mainfrom
samay2504:docs/testing-data-setup
Open

docs: add local test data setup step#523
samay2504 wants to merge 1 commit into
pysal:mainfrom
samay2504:docs/testing-data-setup

Conversation

@samay2504

Copy link
Copy Markdown

This PR updates contributor guidance with a short local workflow for editable installation, dataset preparation, and test execution, and it explicitly documents running libpysal.examples.fetch_all() before tests so contributors avoid missing-data failures during local runs.

Copilot AI review requested due to automatic review settings April 11, 2026 17:23

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates contributor documentation to include a short local workflow that ensures required example datasets are available before running tests.

Changes:

  • Adds a “Local development and tests” section describing editable install with dev extras.
  • Documents pre-fetching libpysal example datasets via libpysal.examples.fetch_all() to avoid missing-data test failures.
  • Provides a basic command to run the test suite locally.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/CONTRIBUTING.md
Comment on lines +15 to +29
```bash
pip install -e ".[dev]"
```

2. Download required example datasets before running tests:

```bash
python -c "import libpysal; libpysal.examples.fetch_all()"
```

3. Run the test suite:

```bash
pytest spopt/tests/
```

Copilot AI Apr 11, 2026

Copy link

Choose a reason for hiding this comment

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

These fenced code blocks are indented with hard tab characters. GitHub-flavored Markdown can render tabs inconsistently inside ordered lists, and this also introduces literal tabs into the file. Prefer indenting the fenced blocks with spaces (typically 4 spaces under the list item) and update the other two blocks similarly for consistent rendering.

Suggested change
```bash
pip install -e ".[dev]"
```
2. Download required example datasets before running tests:
```bash
python -c "import libpysal; libpysal.examples.fetch_all()"
```
3. Run the test suite:
```bash
pytest spopt/tests/
```
```bash
pip install -e ".[dev]"
```
2. Download required example datasets before running tests:
```bash
python -c "import libpysal; libpysal.examples.fetch_all()"
```
3. Run the test suite:
```bash
pytest spopt/tests/
```

Copilot uses AI. Check for mistakes.
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.

2 participants