unifiedwvalticolocs

Very first steps

Initialize your code

1. Initialize git inside your repo:

cd unifiedwvalticolocs && git init

2. Create a virtual environment and install the project in editable mode with its dev dependencies:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

(any Python 3.11+ environment works — venv, conda/micromamba, or uv venv)

3. Install pre-commit hooks:

pre-commit install

4. Run the codestyle:

pre-commit run --all-files

5. Upload initial code to GitHub:

git add .
git commit -m ":tada: Initial commit"
git branch -M main
git remote add origin https://github.com/umr-lops/unifiedwvalticolocs.git
git push -u origin main

Set up bots

• Set up Dependabot to ensure you have the latest dependencies.
• Set up Stale bot for automatic issue closing.

Packaging: Hatchling

The project is packaged with Hatchling as the build backend, with hatch-vcs deriving the package version straight from git tags — there's no version to bump by hand in pyproject.toml.

Building and releasing your package

Building a new version of the application contains steps:

• Tag the commit with the new version, e.g. git tag 2026.5.1 (hatch-vcs reads this to set the package version — no file to edit). Follow Semantic Versions for the tag name.
• Push the tag to GitHub: git push origin 2026.5.1.
• Create a GitHub release from that tag.
• Build and publish: python -m build && twine upload dist/* (or uv build && uv publish).

🎯 What's next

Well, that's up to you 💪🏻. I can only recommend the packages and articles that helped me.

• Typer is great for creating CLI applications.
• Rich makes it easy to add beautiful formatting in the terminal.
• Pydantic – data validation and settings management using Python type hinting.
• Loguru makes logging (stupidly) simple.
• tqdm – fast, extensible progress bar for Python and CLI.
• IceCream is a little library for sweet and creamy debugging.
• orjson – ultra fast JSON parsing library.
• Returns makes you function's output meaningful, typed, and safe!
• Hydra is a framework for elegantly configuring complex applications.
• FastAPI is a type-driven asynchronous web framework.

Articles:

• Open Source Guides.
• A handy guide to financial support for open source
• GitHub Actions Documentation.
• Maybe you would like to add gitmoji to commit names. This is really funny. 😄

🚀 Features

Development features

• Supports Python 3.11 and higher.
• Hatchling as the build backend, with hatch-vcs for git-tag-based versioning. See configuration in pyproject.toml.
• Automatic codestyle with black, isort and pyupgrade.
• Ready-to-use pre-commit hooks with code-formatting.
• Type checks with mypy; docstring checks with darglint; security checks with safety and bandit
• Testing with pytest.
• Ready-to-use .editorconfig and .gitignore. You don't have to worry about those things.

Deployment features

• GitHub integration: issue and pr templates.
• Github Actions with predefined build workflow as the default CI/CD.
• Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, etc with Makefile. More details in makefile-usage.
• Apptainer image definition in apptainer.def for HPC runs.
• Always up-to-date dependencies with @dependabot. You will only enable it.
• Automatic drafts of new releases with Release Drafter. You may see the list of labels in release-drafter.yml. Works perfectly with Semantic Versions specification.

Open source community features

• Ready-to-use Pull Requests templates and several Issue templates.
• Files such as: LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md are generated automatically.
• Stale bot that closes abandoned issues after a period of inactivity. (You will only need to setup free plan). Configuration is here.
• Semantic Versions specification with Release Drafter.

Installation

pip install -U unifiedwvalticolocs

or with uv:

uv pip install -U unifiedwvalticolocs

For development (editable install with dev tools):

pip install -e ".[dev]"

Makefile usage

Makefile contains a lot of functions for faster development.

make install

make pre-commit-install

make codestyle

# or use synonym
make formatting

make check-codestyle

make update-dev-deps

make check-safety

make mypy

make test

make lint

make test && make check-codestyle && make mypy && make check-safety

make pycache-remove

make build-remove

make dsstore-remove

make mypycache-remove

make cleanup

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification. Versions are tagged in git and read automatically at build time by hatch-vcs — there is no version field to update by hand.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you're ready. With the categories option, you can categorize pull requests in release notes using labels.

List of labels and corresponding titles

You can update it in release-drafter.yml.

GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

📃 Citation

@misc{unifiedwvalticolocs,
  author = {umr-lops},
  title = {lib python to generate colocs S1 WV with CMEMS or CCI seatstate altimeters},
  year = {2026},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/umr-lops/unifiedwvalticolocs}}
}

Credits

This project was generated with python-package-template