Skip to content
Open
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
28 changes: 28 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: CI

on:
pull_request:
push:
branches:
- main

jobs:
test:
name: "Test (Python ${{ matrix.python-env }})"
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-env: [py310, py311, py312, py313]

steps:
- uses: actions/checkout@v4

- name: Install pixi
uses: prefix-dev/setup-pixi@v0.8.1
with:
pixi-version: latest
cache: true

- name: Run CI (lint, fmt-check, tests)
run: pixi run --environment ${{ matrix.python-env }} ci
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,3 @@ pip-delete-this-directory.txt
# pixi environments
.pixi/*
!.pixi/config.toml
pixi.lock
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,40 @@ GitHub Projects V2 terminal board viewer. Fetches project data via the GitHub Gr

## Installation

### Via uvx (no clone or PyPI needed)

Run once without installing anything permanently:

```bash
uvx --from git+https://github.com/rudolfjs/cliject cliject board 4
```

Install persistently so `cliject` is on your PATH:

```bash
uv tool install git+https://github.com/rudolfjs/cliject
cliject board 4
```

Pin to a specific tag or commit:

```bash
pip install -e .
uvx --from git+https://github.com/rudolfjs/cliject@v0.1.0 cliject board 4
```

### Via pixi (if you have pixi but not uv)

Install `uv` globally with pixi to get `uvx` on your PATH, then use it as above:

```bash
pixi global install uv
uvx --from git+https://github.com/rudolfjs/cliject cliject board 4
```

### Local development

```bash
pip install -e ".[dev]"
```

## Usage
Expand Down
2 changes: 1 addition & 1 deletion cliject/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def board(

@app.command()
def column(
column_name: Optional[str] = typer.Argument(None, help="Column name to display (uses config default_column if omitted)"),
column_name: Optional[str] = typer.Argument(None, help="Column name to display (default: config default_column)"),
number: Optional[int] = typer.Option(None, "--board", "-b", help="Project number (uses config default if omitted)"),
org: Optional[str] = typer.Option(None, "--org", "-o", help="GitHub organization login"),
group_by: str = typer.Option("Status", "--group-by", "-g", help="Field name to group by"),
Expand Down
Loading