Skip to content

Commit

Permalink
Merge pull request #72 from wayfair-incubator/release-0.2.0
Browse files Browse the repository at this point in the history
Release 0.2.0
  • Loading branch information
James Curtin authored Oct 1, 2021
2 parents 06571bc + 1b0b513 commit bb373a8
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion little_cheesemonger/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"

0 comments on commit bb373a8

Please sign in to comment.