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
41 changes: 41 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: CI

on:
push:
branches: ["main"]
pull_request:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- run: pip install ruff
- run: ruff check .
- run: ruff format --check .

test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- run: pip install -e ".[dev]"
- run: pytest

typecheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- run: pip install -e ".[dev]"
- run: mypy src/
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.1.0] - 2026-05-26

### Added

- Initial project skeleton.
41 changes: 40 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,40 @@
# PyWeather
# PyWeather

A Python weather library.

## Installation

```bash
pip install pyweather
```

## Development

```bash
git clone https://github.com/citizenweather/pyweather
cd pyweather
pip install -e ".[dev]"
```

Run the test suite:

```bash
pytest
```

Lint and format:

```bash
ruff check .
ruff format .
```

Type-check:

```bash
mypy src/
```

## License

GPL-3.0 — see [LICENSE](LICENSE).
52 changes: 52 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "pyweather"
version = "0.1.0"
description = "A Python weather library"
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.10"
authors = [{ name = "Aidan Hogg", email = "aidankhogg@gmail.com" }]
keywords = ["weather"]
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]
dependencies = []

[project.optional-dependencies]
dev = ["pytest", "pytest-cov", "ruff", "mypy"]

[project.urls]
Homepage = "https://github.com/citizenweather/pyweather"
Repository = "https://github.com/citizenweather/pyweather"
Issues = "https://github.com/citizenweather/pyweather/issues"

[tool.hatch.build.targets.wheel]
packages = ["src/pyweather"]

[tool.ruff]
line-length = 88
target-version = "py310"

[tool.ruff.lint]
select = ["E", "F", "I", "UP"]

[tool.mypy]
python_version = "3.10"
strict = true

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "--cov=pyweather --cov-report=term-missing"

[tool.coverage.run]
source = ["src/pyweather"]
4 changes: 4 additions & 0 deletions src/pyweather/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
"""PyWeather — a Python weather library."""

__version__ = "0.1.0"
__all__: list[str] = []
Empty file added tests/__init__.py
Empty file.
6 changes: 6 additions & 0 deletions tests/test_pyweather.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import pyweather


def test_version() -> None:
assert isinstance(pyweather.__version__, str)
assert pyweather.__version__ != ""
Loading