Merge pull request #20 from AI-Hypercomputer/lukebaumann-patch-1

Preparing for releasing on PyPI.

Author: lukebaumann

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+<!--
+
+Changelog follow the https://keepachangelog.com/ standard (at least the headers)
+
+This allow to:
+
+* auto-parsing release notes during the automated releases from github-action:
+  https://github.com/marketplace/actions/pypi-github-auto-release
+* Have clickable headers in the rendered markdown
+
+To release a new version (e.g. from `1.0.0` -> `2.0.0`):
+
+* Create a new `# [2.0.0] - YYYY-MM-DD` header and add the current
+  `[Unreleased]` notes.
+* At the end of the file:
+  * Define the new link url:
+  `[2.0.0]: https://github.com/google-research/my_project/compare/v1.0.0...v2.0.0`
+  * Update the `[Unreleased]` url: `v1.0.0...HEAD` -> `v2.0.0...HEAD`
+
+-->
+
+## [Unreleased]
+* Updated `setup.py` to `pyproject.toml`
+* Added this changelog
+
+## [0.0.6] - 2024-10-10
+* Decreased logging severity for most logs
+* Persistence enabled
+* General argument type fixes
+
+[Unreleased]: https://github.com/AI-Hypercomputer/pathways-utils/compare/v0.0.6...HEAD
+

README.md

@@ -1,3 +1,7 @@
-Package of Pathways-on-Cloud utilities
+# Package of Pathways-on-Cloud utilities
 
-For customers to utilize Pathways-on-Cloud, there are several in changes that need to be made to the user job. We want to encapsulate these changes to a single Python package for two primary reasons. First, most of the changes are temporary patches that will not be needed long-term. Second, several of the changes follow anti-patterns and we want to confine them to a single repository.
+For customers to utilize Pathways-on-Cloud, there are several changes needed by
+the user job. We encapsulate these changes in a single Python package for two
+primary reasons. First, some of the changes are temporary patches that will not
+be needed long-term. Second, several of the changes follow anti-patterns and
+are now confined to a single repository.

pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+# Project metadata. Available keys are documented at:
+# https://packaging.python.org/en/latest/specifications/declaring-project-metadata
+name = "pathwaysutils"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [{name = "Pathways-on-Cloud Utilities Developers", email="[email protected]"}]
+classifiers = [  # List of https://pypi.org/classifiers/
+    "License :: OSI Approved :: Apache Software License",
+]
+keywords = []
+
+dependencies = [
+    "absl-py",
+    "fastapi",
+    "google-cloud-logging",
+    "jax>=0.4.26",
+    "orbax-checkpoint",
+    "uvicorn",
+]
+
+# `version` is automatically set by flit to use `my_project.__version__`
+# `description` is automatically set by flit to use `my_project.__doc__`
+dynamic = ["version", "description"]
+
+[project.urls]
+homepage = "https://github.com/AI-Hypercomputer/pathways-utils"
+repository = "https://github.com/AI-Hypercomputer/pathways-utils"
+changelog = "https://github.com/AI-Hypercomputer/pathways-utils/blob/main/CHANGELOG.md"
+# documentation = ""
+
+[project.optional-dependencies]
+# Development deps (unittest, linting, formating,...)
+# Installed through `pip install -e .[dev]`
+dev = [
+    "pytest",
+    "pytest-xdist",
+    "pylint>=2.6.0",
+    "pyink",
+]
+
+[tool.pyink]
+# Formatting configuration to follow Google style-guide
+line-length = 80
+unstable = true
+pyink-indentation = 2
+pyink-use-majority-quotes = true
+
+[build-system]
+requires = ["flit_core >=3.8,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.sdist]
+exclude = [
+  "**/*_test.py",
+]
+