Skip to content

update project setup instructions #8

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.

Sign up for GitHub

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

Merged
jdungan merged 1 commit into from
Mar 14, 2025
Merged

update project setup instructions #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ data/audio/
data/video/
data/transcripts/
models/
notebooks/.ipynb_checkpoints/

# Python
__pycache__/
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,26 @@ poetry self add poetry-plugin-shell
poetry shell

# Install Jupyter kernel for this environment (needed for Jupyter notebooks)
poetry run python -m ipykernel install --user --name=tgov-scraper --display-name="TGOV Scraper"
python -m ipykernel install --user --name=tgov-scraper --display-name="TGOV Scraper"
```

## Running

```bash
poetry run jupyter notebook
jupyter notebook
```

## Running Tests

```bash
# Run all tests
poetry run pytest
pytest

# Run specific tests
poetry run pytest tests/test_meetings.py
pytest tests/test_meetings.py

# Run tests with verbose output
poetry run pytest -v
pytest -v
```

## Project Structure
Expand Down
6 changes: 5 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["jdungan <johnadungan@gmail.com>"]
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.10"
python = "3.11.*"
selectolax = "^0.3.28"
aiohttp = "^3.11.13"
pytest-asyncio = "^0.25.3"
Expand All @@ -25,6 +25,10 @@ jupyter-nbextensions-configurator = "^0.6.4"
faster-whisper = "^1.1.1"


[tool.poetry.group.dev.dependencies]
jupyter = "^1.1.1"
ipykernel = "^6.29.5"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"