diff --git a/.copier-answers.yml b/.copier-answers.yml index c48be75..26c9ba4 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -3,12 +3,12 @@ _commit: v0.1.0-8-ga0c8676 _src_path: gh:alan-turing-institute/python-project-template coc: our_coc email: nsimpson@turing.ac.uk -full_name: Cloudcast Maintainers +full_name: cloudcasting Maintainers license: MIT min_python_version: '3.10' org: climetrend -project_name: cloudcast +project_name: cloudcasting project_short_description: Tooling and infrastructure to enable cloud nowcasting. -python_name: cloudcast +python_name: cloudcasting typing: strict -url: https://github.com/climetrend/cloudcast +url: https://github.com/climetrend/cloudcasting diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 12eb513..3c90c88 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,7 +2,7 @@ We value the participation of every member of our community and want to ensure that every contributor has an enjoyable and fulfilling experience. Accordingly, -everyone who participates in the cloudcast project is expected to show respect and courtesy to other community members at all time. +everyone who participates in the cloudcasting project is expected to show respect and courtesy to other community members at all time. In the interest of fostering an open and welcoming environment, we as contributors and maintainers are dedicated to making participation in our project diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67b4fdb..e04c203 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ pytest Use pytest-cov to generate coverage reports: ```bash -pytest --cov=cloudcast +pytest --cov=cloudcasting ``` # Pre-commit diff --git a/LICENSE b/LICENSE index df111dc..c204431 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright 2024 Cloudcast Maintainers +Copyright 2024 cloudcasting Maintainers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index 99ba07f..0a02163 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# cloudcast +# cloudcasting [![Actions Status][actions-badge]][actions-link] [![PyPI version][pypi-version]][pypi-link] @@ -10,8 +10,8 @@ Tooling and infrastructure to enable cloud nowcasting. From source (development mode): ```bash -git clone https://github.com/climetrend/cloudcast -cd cloudcast +git clone https://github.com/climetrend/cloudcasting +cd cloudcasting python -m pip install ".[dev]" ``` @@ -25,9 +25,9 @@ For making changes, see the [guidance on development](https://github.com/alan-tu ## Usage ```bash - cloudcast download --help + cloudcasting download --help - Usage: cloudcast download [OPTIONS] START_DATE END_DATE OUTPUT_DIRECTORY + Usage: cloudcasting download [OPTIONS] START_DATE END_DATE OUTPUT_DIRECTORY Download a selection of the available EUMETSAT data. Each calendar year of data within the supplied date range will be saved to a @@ -87,7 +87,7 @@ For making changes, see the [guidance on development](https://github.com/alan-tu Example: ```bash -cloudcast download "2020-06-01 00:00" "2020-06-30 23:55" "path/to/my/dir/data.zarr" +cloudcasting download "2020-06-01 00:00" "2020-06-30 23:55" "path/to/my/dir/data.zarr" ``` @@ -101,9 +101,9 @@ Distributed under the terms of the [MIT license](LICENSE). -[actions-badge]: https://github.com/climetrend/cloudcast/workflows/CI/badge.svg -[actions-link]: https://github.com/climetrend/cloudcast/actions -[pypi-link]: https://pypi.org/project/cloudcast/ -[pypi-platforms]: https://img.shields.io/pypi/pyversions/cloudcast -[pypi-version]: https://img.shields.io/pypi/v/cloudcast +[actions-badge]: https://github.com/climetrend/cloudcasting/workflows/CI/badge.svg +[actions-link]: https://github.com/climetrend/cloudcasting/actions +[pypi-link]: https://pypi.org/project/cloudcasting/ +[pypi-platforms]: https://img.shields.io/pypi/pyversions/cloudcasting +[pypi-version]: https://img.shields.io/pypi/v/cloudcasting diff --git a/pyproject.toml b/pyproject.toml index fe26e40..47481b3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta" [project] -name = "cloudcast" +name = "cloudcasting" version = "0.1.0" authors = [ - { name = "Cloudcast Maintainers", email = "nsimpson@turing.ac.uk" }, + { name = "cloudcasting Maintainers", email = "nsimpson@turing.ac.uk" }, ] description = "Tooling and infrastructure to enable cloud nowcasting." readme = "README.md" @@ -46,13 +46,13 @@ dev = [ ] [project.scripts] -cloudcast = "cloudcast.cli:app" +cloudcasting = "cloudcasting.cli:app" [project.urls] -Homepage = "https://github.com/climetrend/cloudcast" -"Bug Tracker" = "https://github.com/climetrend/cloudcast/issues" -Discussions = "https://github.com/climetrend/cloudcast/discussions" -Changelog = "https://github.com/climetrend/cloudcast/releases" +Homepage = "https://github.com/climetrend/cloudcasting" +"Bug Tracker" = "https://github.com/climetrend/cloudcasting/issues" +Discussions = "https://github.com/climetrend/cloudcasting/discussions" +Changelog = "https://github.com/climetrend/cloudcasting/releases" [tool.pytest.ini_options] minversion = "6.0" @@ -67,7 +67,7 @@ testpaths = [ ] [tool.coverage] -run.source = ["cloudcast"] +run.source = ["cloudcasting"] port.exclude_lines = [ 'pragma: no cover', '\.\.\.', @@ -86,7 +86,7 @@ strict = true enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"] [[tool.mypy.overrides]] -module = "cloudcast.*" +module = "cloudcasting.*" disallow_untyped_defs = true disallow_incomplete_defs = true @@ -98,8 +98,8 @@ ignore_missing_imports = true [[tool.mypy.overrides]] module = [ - "cloudcast.download", - "cloudcast.cli", + "cloudcasting.download", + "cloudcasting.cli", ] disallow_untyped_calls = false diff --git a/src/cloudcast/__main__.py b/src/cloudcast/__main__.py deleted file mode 100644 index 6925dd0..0000000 --- a/src/cloudcast/__main__.py +++ /dev/null @@ -1,3 +0,0 @@ -from cloudcast.cli import app - -app() diff --git a/src/cloudcast/__init__.py b/src/cloudcasting/__init__.py similarity index 60% rename from src/cloudcast/__init__.py rename to src/cloudcasting/__init__.py index b76a40d..c7e79be 100644 --- a/src/cloudcast/__init__.py +++ b/src/cloudcasting/__init__.py @@ -1,12 +1,12 @@ """ -cloudcast: Tooling and infrastructure to enable cloud nowcasting. +cloudcasting: Tooling and infrastructure to enable cloud nowcasting. """ from __future__ import annotations from importlib.metadata import version -from cloudcast import cli, download +from cloudcasting import cli, download __all__ = ("__version__", "download", "cli") __version__ = version(__name__) diff --git a/src/cloudcasting/__main__.py b/src/cloudcasting/__main__.py new file mode 100644 index 0000000..96480f3 --- /dev/null +++ b/src/cloudcasting/__main__.py @@ -0,0 +1,3 @@ +from cloudcasting.cli import app + +app() diff --git a/src/cloudcast/cli.py b/src/cloudcasting/cli.py similarity index 72% rename from src/cloudcast/cli.py rename to src/cloudcasting/cli.py index 721e8f4..599b0be 100644 --- a/src/cloudcast/cli.py +++ b/src/cloudcasting/cli.py @@ -1,6 +1,6 @@ import typer -from cloudcast.download import download_satellite_data +from cloudcasting.download import download_satellite_data # typer app code app = typer.Typer() diff --git a/src/cloudcast/download.py b/src/cloudcasting/download.py similarity index 100% rename from src/cloudcast/download.py rename to src/cloudcasting/download.py diff --git a/src/cloudcast/py.typed b/src/cloudcasting/py.typed similarity index 100% rename from src/cloudcast/py.typed rename to src/cloudcasting/py.typed diff --git a/tests/test_download.py b/tests/test_download.py index 1b875dc..8876fb8 100644 --- a/tests/test_download.py +++ b/tests/test_download.py @@ -3,7 +3,7 @@ import pytest from typer.testing import CliRunner -from cloudcast.cli import app +from cloudcasting.cli import app @pytest.fixture()