Skip to content

Latest commit

 

History

History
375 lines (268 loc) · 14.1 KB

CHANGELOG.md

File metadata and controls

375 lines (268 loc) · 14.1 KB
Raw

Changelog

All notable changes to this project will be documented in this file. knockoff-factory adheres to Semantic Versioning.

4.x Releases

3.x Releases

2.x Releases

1.x Releases

Unreleased

Added

Updated

Deprecated

Removed

Fixed

4.4.1

Updated

4.4.0

Added

Updated

Removed

4.3.2

Removed

Updated

  • Updated dependency-injector version to resolve poetry lock issue with six <=1.15.0.

4.3.1

Fixed

  • Fixed backwards compatibility issue in KnockoffContainer with sqlalchemy breaking change for create_engine's positional arg changing into a kwarg, url.
  • Fix KnockoffDB class so that it actually skips inserts where insert=False for a node
  • Fix KnockoffTableFactory so that if you pass next_strategy_factory it won't complain about also providing next_strategy_callable

4.3.0

Added

  • io utilities for parallelizing writes to sql with joblib
  • Added rename and drop parameters for KnockoffTable
  • Added support for MySQL to TempDatabaseService (knockoff.tempdb.setup_teardown:mysql_setup_teardown)
  • Added reflect_schema method to KnockoffDatabaseService

Updated

  • Moved knockoff.testing_postgresql modules to knockoff.utilities.testing.postgresql
  • Parallelized DefaultDatabaseService inserts
  • Moved existing yaml based cli examples to examples/legacy
  • Renamed KnockoffTable.build_record method to KnockoffTable._build_record declaring it as private by convention
  • Added docstrings for KnockoffTable, ColumnFactory and CollectionsFactory

Fixed

  • Fixed DefaultDatabaseService's reflect_table method for MySql

4.2.1

Added

  • Documentation and jupyter notebook for the knockoff run CLI
  • Added default configurations for knockoff run CLI with environment variable override options

Updated

  • Moved clear_env_vars from knockoff.orm to knockoff.utilities.environ

Fixed

  • Fixed issue where knockoff run CLI was not using the temp db created with the --ephemeral flag

4.2.0

Note: The python package and docker image for this version was released as 4.1.1.

Added

  • Add --ephemeral flag for knockoff run CLI to create temp database for loading knockoff configuration from sdk
  • Add unit tests for KnockoffDB.build and knockoff run CLI
  • Documentation and jupyter notebook for TempDatabaseService
  • Documentation and jupyter notebook for KnockoffDB

Updated

  • Moved legacy YAML based knockoff cli from README.md to legacy.MD

Fixed

4.1.0

Added

  • CollectionsFactory for providing factory functions that return multiple columns
  • Documentation and jupyter notebook for KnockoffTable

Updated

Fixed

4.0.0

Added

  • ColumnFactory for providing factory functions instead of requiring as a tuple (column, factory)
  • build method for KnockoffDB to enable building dataframes without inserting into DB
  • Unit tests for column and collection factories
  • run CLI command for loading data into database from sdk configuration
  • Add Blueprint class to sdk for more composable configuration
  • Added unit tests for knockoff.utilities.mixin
  • Added tempdb module and TempDatabaseService class

Updated

  • Made CLI extensible with injectable subcommands
  • Moved previous CLI to legacy subcommand for loading data into database using yaml configuration
  • Renamed knockoff.utilities.mixin:FactoryMixin to knockoff.utilities.mixin:ResourceLocatorMixin
  • Remove dependency on python-interface, use abc instead
  • Updated internal knockoff fixtures to use TempDatabaseService

Fixed

  • Fixed legacy CLI command by resolving breaking changes in sqlalchemy engine interface

3.1.1

Updated

3.1.0

Added

3.0.0

Deprecated

Fixed

2.1.0

Added

  • dag_service and dependency handling for KnockoffDB

2.0.0

Updated

  • SDK interface to simplify configuration

1.9.0

Added

  • Python sdk for simple table configuration and pytest fixture setup
  • knockoff.testing_postgresql for unit testing postgres

Fixed

  • Default engine builder setting host instead of uri

1.8.1

Added

Fixed

1.8.0

Added

  • Prototype io to read sql query that returns query result as pandas dataframe

1.7.0

Added

  • Functionality to generate periods part using Intervals

1.6.0

Added

  • Utilities to clear default knockoff environment variables
  • Allow registering databases configured by engine builders in the yaml

1.5.1

Fixed

  • Adding unique constraint on prototypes

1.5.0

Added

  • Knockoff class for interface with library instead of cli

1.4.0

Added

  • Enabled loading prototypes using io strategy

Fixed

  • Only attempt to create databases and users if provided in config

1.3.0

Added

  • Parallelize writes for sql sink
  • read_multi_parquet to read multiple parquet files

1.2.0

Updated

  • Use psycopg2 instead of psycopg2-binary

1.1.0

Added

  • Added injectable dump strategy for tables.
    • Currently supporting
      • sql: pandas dataframe to_sql
      • parquet: pandas dataframe to_parquet
    • Added by Gregory Yu