From 1b0b5139822ab75f0bdcc0a73768f0cc79a824e7 Mon Sep 17 00:00:00 2001 From: James Curtin Date: Fri, 1 Oct 2021 14:19:29 -0400 Subject: [PATCH] Release 0.2.0 --- CHANGELOG.md | 2 ++ README.md | 30 +++++++++++++++--------------- little_cheesemonger/__init__.py | 2 +- 3 files changed, 18 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c85d89..d47d57e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.2.0] - 2021-10-01 + ### Changed * Uppercase Enum keys diff --git a/README.md b/README.md index 3247fbd..ac2a63b 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ # little-cheesemonger -`little-cheesemonger` is a package that can set up a manylinux build environment to compile a -correctly linked manylinux wheel. Configuration data is loaded from a `pyproject.toml` file, or +`little-cheesemonger` is a package that can set up a manylinux build environment to compile a +correctly linked manylinux wheel. Configuration data is loaded from a `pyproject.toml` file, or a custom data loader can be implemented. ## Installation ```bash -pip install little-cheesemonger==0.1.0rc0 +pip install little-cheesemonger==0.2.0 ``` ## Quickstart @@ -46,18 +46,18 @@ steps = [ ] ``` -* `environment_variables` is a list of environment variables to set in the container -prior to building the wheel. They are expected to be in `KEY=VALUE` format. -* `system_dependencies` is a list of CentOS system dependencies to install via `YUM`. -They are expected to be in `package-version` format. -* `python_dependencies` is a list of Python dependencies to install via `pip`. They -are expected to be in `package==version` format. They are currently installed for +* `environment_variables` is a list of environment variables to set in the container +prior to building the wheel. They are expected to be in `KEY=VALUE` format. +* `system_dependencies` is a list of CentOS system dependencies to install via `YUM`. +They are expected to be in `package-version` format. +* `python_dependencies` is a list of Python dependencies to install via `pip`. They +are expected to be in `package==version` format. They are currently installed for all available versions of Python in a given manylinux image. -* `python_versions` is a list of Python versions to install Python dependencies for -in a given manylinux image. They are expected to follow the Python installation directory -naming convention from in the specified manyliniux image, ex. `cp36-cp36m`. Python version names +* `python_versions` is a list of Python versions to install Python dependencies for +in a given manylinux image. They are expected to follow the Python installation directory +naming convention from in the specified manyliniux image, ex. `cp36-cp36m`. Python version names can be found by running `ls /opt/python` in a manylinux image. -* `steps` is a list of steps to execute via bash. Package building and uploading could +* `steps` is a list of steps to execute via bash. Package building and uploading could be implemented here, or `little-cheesemonger` could be integrated into a larger system! # Custom Data Loader @@ -66,9 +66,9 @@ You can pass the path to an importable function, as well as positional and keywo ```bash little-cheesemonger --data-loader path.to.function --loader-arg foo --loader-kwarg foo=bar -``` +``` -Custom data loader functions must accept `directory` as the first argument with positional and keyword arguments passed to the loader function after. The function must return a dictionary of configuration data matching the fields above. +Custom data loader functions must accept `directory` as the first argument with positional and keyword arguments passed to the loader function after. The function must return a dictionary of configuration data matching the fields above. ```python def my_custom_loader(directory: Path, ...) -> Dict: diff --git a/little_cheesemonger/__init__.py b/little_cheesemonger/__init__.py index 00e47a9..1cef6e6 100644 --- a/little_cheesemonger/__init__.py +++ b/little_cheesemonger/__init__.py @@ -7,4 +7,4 @@ from little_cheesemonger._errors import LittleCheesemongerError # noqa from little_cheesemonger._run import run # noqa -__version__ = "0.1.0" +__version__ = "0.2.0"