Skip to content

Commit

Permalink
Rename to sirocco and release 0.0.0-dev0 (#31)
Browse files Browse the repository at this point in the history
After discussion in issue #15 on the name we decided to rename the
package to `sirocco`. We rename the existing code to sirocco and add a
GitHub workflow that publishes a new releases on when pushing a
version tag to main.
  • Loading branch information
agoscinski authored Oct 31, 2024
1 parent 5f942f8 commit 52fd82b
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 13 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/publish-pypi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# This workflow will upload a Python Package using hatch when a release is created

name: Publish Python Package

on:
push:
# only pushes to main trigger
branches: [main]
tags:
- v[0-9]+.[0-9]+.[0-9]+*

permissions:
contents: read

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.12'
- name: Install hatch
run: |
pip install --upgrade pip
pip install hatch
- name: Publish package
env:
HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }}
HATCH_INDEX_USER: __token__
run: |
hatch build
hatch publish
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Changelog
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# ETHIOPIA
# Sirocco

ETHIOPIA (wEaTHer and clImate wOrkflow graPhs for aiIdA)
is a library for creating weather and climate workflows from a yaml
Sirocco is a library for creating weather and climate workflows from a yaml
format inspired by [cylc](https://cylc.github.io/) using
[AiiDA](https://www.aiida.net/) as workflow engine.

Expand Down
2 changes: 1 addition & 1 deletion examples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ To run the example you can use the command

.. code-block:: bash
wcflow files/configs/example_config.yaml
sirocco files/configs/example_config.yaml
It is important to execute it from the examples folder as the relative paths are hardcoded.
18 changes: 13 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ build-backend = "hatchling.build"

[project]
# See https://www.python.org/dev/peps/pep-0621/
name = 'wcflow'
name = 'sirocco'
dynamic = ["version"]
description = 'WcFlow a library for creating weather and climate workflows.'
description = 'A library for creating weather and climate workflows.'
authors = [
{name = 'Matthieu Leclair', email = '[email protected]'},
{name = 'Julian Geiger', email = '[email protected]'},
Expand All @@ -22,14 +22,17 @@ classifiers = [
'Topic :: Scientific/Engineering',
'Topic :: Scientific/Engineering :: Atmospheric Science',
]
keywords = ["wc", "workflow"," icon", "aiida", "aiida-workgraph"]
keywords = ["workflow"," icon", "aiida", "aiida-workgraph"]
requires-python = '>=3.12'
dependencies = [
"isoduration",
"pydantic",
"pydantic-yaml",
"aiida-core>=2.5"
]
[project.urls]
Repository = "https://github.com/C2SM/Sirocco.git"
Changelog = "https://github.com/C2SM/Sirocco/blob/main/CHANGELOG.md"

[tool.pytest.ini_options]
# Configuration for [pytest](https://docs.pytest.org)
Expand All @@ -38,7 +41,7 @@ addopts = "--pdbcls=IPython.terminal.debugger:TerminalPdb"
[tool.coverage.run]
# Configuration of [coverage.py](https://coverage.readthedocs.io)
# reporting which lines of your plugin are covered by tests
source = ["wcflow"]
source = ["sirocco"]

[tool.ruff]
include = ["src/*py", "tests/*py"]
Expand All @@ -52,8 +55,13 @@ ignore = [

## Hatch configurations

[tool.hatch.build.targets.sdist]
include = [
"src/sirocco/",
]

[tool.hatch.version]
path = "src/wcflow/__init__.py"
path = "src/sirocco/__init__.py"

[tool.hatch.envs.hatch-test]
extra-dependencies = [
Expand Down
2 changes: 1 addition & 1 deletion src/wcflow/__init__.py → src/sirocco/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

__all__ = ["parsing"]

__version__ = "0.0.1-dev"
__version__ = "0.0.0-dev0"
2 changes: 1 addition & 1 deletion src/wcflow/core.py → src/sirocco/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from isoduration import parse_duration
from isoduration.types import Duration

from wcflow.parsing._utils import TimeUtils
from sirocco.parsing._utils import TimeUtils

if TYPE_CHECKING:
from collections.abc import Generator
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from isoduration.types import Duration # pydantic needs type # noqa: TCH002
from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator

from wcflow import core
from sirocco import core

from ._utils import TimeUtils

Expand Down
2 changes: 1 addition & 1 deletion tests/test_wc_workflow.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import pytest

from wcflow.parsing import load_workflow_config
from sirocco.parsing import load_workflow_config


@pytest.fixture
Expand Down

0 comments on commit 52fd82b

Please sign in to comment.