v4.0.0rc1

Partial rewrite of some user-facing parts to better accommodate new features, such as groups. A migration guide will be available nearer the stable release.

Please note: this release doesn't have any tests, and may be buggy. It's unlikely much will change between now and stable, but some things may need to be fixed. If you encounter any issues, let me know.

v3.6.0

Additions

• You can now export reports as Polars DataFrames using Report.to_polars()

Changes

• Report.to_arrow_table() has been rewritten, and is vastly improved

v3.5.1

Additions

• Added user_specified as a valid gender dimension (#25)

Changes

• Update landing page to request assets rather than store them (the page itself hasn't changed) (#37)

v3.5.0

Feature release

Additions

• Added the rows, column_headers, ordered_dimensions, and ordered_metrics properties to the Report class (#32)

Changes

• The landing page after authorisation has been redesigned (#35)
• Changed Report.columns to a property (#32)

v3.4.1

Patch release

Fixes

• Fixed an issue where the AuthenticationError was expecting the wrong arguments

v3.4.0

Feature release

This release mainly combats changes in Google's OAuth (see #33 and #34), switching to loopback IP address authorisation over manual copy/paste. This change isn't breaking, unless you absolutely need manual copy/paste auth -- in this instance, set client.legacy_auth = True before authorising.

Additions

• The webserver module, which provides the webserver necessary to perform loopback IP address authorisation
• A port kwarg for the authorise, refresh_token, and retrieve methods of the Analytics and AsyncAnalytics classes, defaulting to 8080
• A legacy_auth read/write property for the Analytics and AsyncAnalytics classes which re-enables manual copy/paste authorisation (if available)

Changes

• Privatised the log (now _log) variables in each module (this is not considered a breaking change as those should not have been accessed anyway)
• The ReportType and DetailedReportType ABCs are now dataclasses

v3.3.2

Patch release

• Addresses a deprecation in the Google APIs regarding manual code input
  • The current solution is a temporary one to get people up and running, but a proper fix will be released in v3.4

v3.3.1

Patch release

This release adds the py.typed file to the distribution.

v3.3.0

Feature release

This release adds and changes a lot of little things.

Additions

• The Analytics.retrieve and AsyncAnalytics.retrieve methods now accept a token_path kwarg to allow users to save their tokens wherever without needing to manually authorise
• The Report class now has dimensions and metrics properties, which return columns that are dimensions and those that are metrics respectively

Changes

• The outdated version warning message was reworded
• The token refresh check is now a little more optimised
• Some imports are a little more optimised

Potential breaking change

• The Report._nrows and Report._ncolumns private attributes have been merged into Report._shape, and thus no longer exist. You should use Report.shape[0] and Report.shape[1] instead. This will cause problems for those using these attributes, but as they are private, this isn't a major version change.

v3.2.0

Feature release

Additions

• Added ability to export report as Apache Arrow Table (#28)
• Added ability to export report as Apache Feather file (#28)
• Added ability to export report as Apache Parquet file (#28)
• Added analytix[arrow] install method (#28)