Skip to content

Commit

Permalink
Merge pull request #17 from jsconan/release-0.5.0
Browse files Browse the repository at this point in the history
Release 0.5.0
  • Loading branch information
jsconan authored Sep 13, 2023
2 parents aa9e1cd + c453e55 commit aa3d831
Show file tree
Hide file tree
Showing 19 changed files with 3,645 additions and 1 deletion.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.5.0] - 2023-09-13

### Added

- `Config` - A class for handling a configuration.
- `ConfigOption` - A class for handling config options.
- `create_options(options)` - Creates config options from a list of descriptors.
- `passthrough(value)` - A passthrough mapper. It returns the value as it is.
- `boolean(value)` - Converts a value to a boolean value.

## [0.4.0] - 2023-09-12

### Added
Expand Down
11 changes: 11 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
## Modules

- [`toolbox`](./toolbox.md#module-toolbox): `py-toolbox` is a collection of utilities offering solutions to a set of common problems.
- [`toolbox.config`](./toolbox.config.md#module-toolboxconfig): The `config` package provides classes for handling a configuration.
- [`toolbox.config.config`](./toolbox.config.config.md#module-toolboxconfigconfig): A class for handling a configuration.
- [`toolbox.config.config_option`](./toolbox.config.config_option.md#module-toolboxconfigconfig_option): A class for handling config options.
- [`toolbox.data`](./toolbox.data.md#module-toolboxdata): A collection of data utilities.
- [`toolbox.data.mappers`](./toolbox.data.mappers.md#module-toolboxdatamappers): A collection of data mappers.
- [`toolbox.files`](./toolbox.files.md#module-toolboxfiles): The `files` package provides several utilities for handling files.
- [`toolbox.files.csv_file`](./toolbox.files.csv_file.md#module-toolboxfilescsv_file): A simple API for reading and writing CSV files.
- [`toolbox.files.file`](./toolbox.files.file.md#module-toolboxfilesfile): A collection of utilities for accessing files.
Expand All @@ -21,6 +26,9 @@

## Classes

- [`config.Config`](./toolbox.config.config.md#class-config): Handles a configuration.
- [`config_option.ConfigOption`](./toolbox.config.config_option.md#class-configoption): Handles a config option.
- [`mappers.ValueMapper`](./toolbox.data.mappers.md#class-valuemapper): The interface for a value mapper.
- [`csv_file.CSVFile`](./toolbox.files.csv_file.md#class-csvfile): Offers a simple API for reading and writing CSV files.
- [`file_manager.FileManager`](./toolbox.files.file_manager.md#class-filemanager): Offers a simple API for reading and writing files.
- [`json_file.JSONFile`](./toolbox.files.json_file.md#class-jsonfile): Offers a simple API for reading and writing JSON files.
Expand All @@ -30,6 +38,9 @@

## Functions

- [`config_option.create_options`](./toolbox.config.config_option.md#function-create_options): Create options from a list of descriptors.
- [`mappers.boolean`](./toolbox.data.mappers.md#function-boolean): Converts a value to a boolean value.
- [`mappers.passthrough`](./toolbox.data.mappers.md#function-passthrough): A passthrough mapper. It returns the value as it is.
- [`csv_file.read_csv_file`](./toolbox.files.csv_file.md#function-read_csv_file): Reads a CSV content from a file.
- [`csv_file.write_csv_file`](./toolbox.files.csv_file.md#function-write_csv_file): Writes a CSV content to a file.
- [`file.get_file_mode`](./toolbox.files.file.md#function-get_file_mode): Gets the file access mode given the expectations.
Expand Down
Loading

0 comments on commit aa3d831

Please sign in to comment.