Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
330e86f
build: setup initial build files and workflow to try to align with st…
arjunsridhar12345 May 21, 2026
50d2a3f
feat: add raw data loader module
arjunsridhar12345 May 21, 2026
1902aa2
feat: add raw data loader again
arjunsridhar12345 May 21, 2026
3c1771a
test: add initial tests for raw data loader
arjunsridhar12345 May 21, 2026
614ef16
docs: try to update contributing markdown to align with standards
arjunsridhar12345 May 21, 2026
a54f01a
build: require python 3.12 for TypeAliasType class
arjunsridhar12345 May 21, 2026
852e8a3
ci: add matrix to test across different operating systems
arjunsridhar12345 May 21, 2026
0d193f3
build: update lock file
arjunsridhar12345 May 21, 2026
d01c441
refactor: make comment for temp_dataset more clear
arjunsridhar12345 May 21, 2026
d229261
refactor: fix markdown cell with correct function and simplify docs
arjunsridhar12345 May 21, 2026
f61bba4
build: use github release to follow coding standard instead of hash
arjunsridhar12345 May 21, 2026
cd70721
refactor: small minor tweaks to markdown cells
arjunsridhar12345 May 22, 2026
51a30ff
ci: set fail fast to true for automated workflow tests
arjunsridhar12345 May 22, 2026
62fd50a
refactor: try to add more clarity to markdown cells
arjunsridhar12345 May 23, 2026
228b8fe
refactor: remove adding unncessary stream that failed to load
arjunsridhar12345 May 24, 2026
cc41d26
build: set line length to 100 to match coding standards
arjunsridhar12345 May 24, 2026
160b68c
refactor: rename property to try to be more concise and minor lint
arjunsridhar12345 May 24, 2026
ceca81e
docs: add more details on raw data loader examplde markdown cell
arjunsridhar12345 May 24, 2026
cbfce73
refactor: skip streams that failed to load
arjunsridhar12345 May 27, 2026
e0f2d6c
style: linting
arjunsridhar12345 May 27, 2026
fe5e0f2
test: fix failing test
arjunsridhar12345 May 27, 2026
2ae71b1
feat: add small cell about accessing path attribute
arjunsridhar12345 May 28, 2026
5286ee9
refactor: PR feedback. rename to loader.py and type hint
arjunsridhar12345 May 29, 2026
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
11 changes: 7 additions & 4 deletions .github/workflows/test_and_lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ on:
pull_request:
branches:
- main
- dev

jobs:
ci:
runs-on: ubuntu-latest
runs-on: ${{ matrix.os }}
strategy:
fail-fast: true
matrix:
python-version: [ '3.10', '3.11', '3.12' ]
os: [ ubuntu-latest, macos-latest, windows-latest ]
python-version: [ '3.12' ]
Comment thread
arjunsridhar12345 marked this conversation as resolved.
steps:
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
Expand All @@ -20,6 +23,6 @@ jobs:
- name: Install dependencies
run: uv sync
- name: Run linter checks
run: uv run flake8 . && uv run interrogate --verbose .
run: uv run ruff check . && uv run ruff format --check . && uv run interrogate --verbose .
- name: Run tests and coverage
run: uv run coverage run -m unittest discover && uv run coverage report
run: uv run coverage run -m pytest && uv run coverage report
30 changes: 20 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,43 @@

### Linters and testing

There are several libraries used to run linters, check documentation, and run tests.
This project uses [uv](https://docs.astral.sh/uv/) to manage its environment and
[ruff](https://docs.astral.sh/ruff/) for linting and formatting.

- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:
- Install dependencies (including the `dev` group):

```bash
coverage run -m unittest discover && coverage report
uv sync
```

- Run tests with **pytest** under **coverage**:

```bash
uv run coverage run -m pytest && uv run coverage report
```

- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:

```bash
interrogate .
uv run interrogate .
```

- Use **flake8** to check that code is up to standards (no unused imports, etc.):
- Use **ruff** to lint the code (catches unused imports, style issues, sorts imports, etc.):

```bash
flake8 .
uv run ruff check .
```

- Use **black** to automatically format the code into PEP standards:
- Use **ruff** to automatically format the code:

```bash
black .
uv run ruff format .
```

- Use **isort** to automatically sort import statements:
- To apply ruff's autofixes in one shot:

```bash
isort .
uv run ruff check --fix . && uv run ruff format .
```

### Pull requests
Expand Down
Loading
Loading