stach-extensions

This repository contains extension libraries in different languages for parsing the stach format to more simpler to consume formats or data structures.

As of now the languages supported are Java, Python, .Net and R. The source code for the supported languages is organized in the respective language folders in the root directory

Installation

python

pip install fds.protobuf.stach.extensions

java

Add the below dependency to the project

<dependency>
  <groupId>com.factset.protobuf</groupId>
  <artifactId>stachextensions</artifactId>
  <version>ARTIFACT_VERSION</version>
</dependency>

dotnet

• Install with Package Manager Console:

  Install-Package FactSet.Protobuf.Stach.Extensions

• Install with NuGet:

  nuget install FactSet.Protobuf.Stach.Extensions

• Install with .NET Core:

  dotnet add package FactSet.Protobuf.Stach.Extensions

R

install.packages('factset.protobuf.stach.v2')
install.packages('factset.protobuf.stachextensions')

Usage

There are methods for converting the stach format to the tabular formats in the respective stach extensions classes as shown below and also refer to the tests folder inside each language for detailed usage

python

# Stach v2 Row Organized format
stachBuilder = StachExtensionFactory.get_row_organized_builder(StachVersion.V2)
stachBuilder.set_package(data)  # data is the stach input in string or object format
# rowOrganizedPackage = stachBuilder.get_package()
stachExtension = stachBuilder.build()
dataFramesList = stachExtension.convert_to_dataframe()


# Stach v2 Column Organized format
stachBuilder = StachExtensionFactory.get_column_organized_builder(StachVersion.V2)
stachBuilder.set_package(data)  # data is the stach input in string or object format
# package = stachBuilder.get_package()  # Package from fds.protobuf.stach.v2
stachExtension = stachBuilder.build()
dataFramesList = stachExtension.convert_to_dataframe()


# Stach v1 Column Organized format
stachBuilder = StachExtensionFactory.get_column_organized_builder(StachVersion.V1)
stachBuilder.set_package(data)  # data is the stach input in string or object format
# package = stachBuilder.get_package()  # Package from fds.protobuf.stach
stachExtension = stachBuilder.build()
dataFramesList = stachExtension.convert_to_dataframe()

java

// Stach v2 Row Organized format
RowStachExtensionBuilder stachExtensionBuilder = StachExtensionFactory.getRowOrganizedBuilder(StachVersion.V2);
stachExtensionBuilder.setPackage(data);  // data is the stach input in string or object format
// RowOrganizedPackage rowOrganizedPackage = stachExtensionBuilder.getPackage();
StachExtensions stachExtension = stachExtensionBuilder.build();
List<TableData> tableDataList = stachExtension.convertToTable();


// Stach v2 Column Organized format
ColumnStachExtensionBuilder stachExtensionBuilder = StachExtensionFactory.getColumnOrganizedBuilder(StachVersion.V2);
stachExtensionBuilder.setPackage(data);  // data is the stach input in string or object format
// com.factset.protobuf.stach.v2.PackageProto.Package pkg = (com.factset.protobuf.stach.v2.PackageProto.Package) stachExtensionBuilder.getPackage();
StachExtensions stachExtension = stachExtensionBuilder.build();
List<TableData> tableDataList = stachExtension.convertToTable();


// Stach v1 Column Organized format
ColumnStachExtensionBuilder stachExtensionBuilder = StachExtensionFactory.getColumnOrganizedBuilder(StachVersion.V1);
stachExtensionBuilder.setPackage(data); // data is the stach input in string or object format
// com.factset.protobuf.stach.PackageProto.Package pkg = (com.factset.protobuf.stach.PackageProto.Package) stachExtensionBuilder.getPackage();
StachExtensions stachExtension = stachExtensionBuilder.build();
List<TableData> tableDataList = stachExtension.convertToTable();

dotnet

// Stach v2 Row Organized format
var rowStachBuilder = StachExtensionFactory.GetRowOrganizedBuilder();
rowStachBuilder.SetPackage(data);  // data is the stach input in string or object format
// var rowOrganizedPackage = rowStachBuilder.GetPackage();
var stachExtension = rowStachBuilder.Build();
var table = stachExtension.ConvertToTable();


// Stach v2 Column Organized format
var columnStachBuilder = StachExtensionFactory.GetColumnOrganizedBuilder<Stach.V2.Package>();
columnStachBuilder.SetPackage(data);  // data is the stach input in string or object format
// var package = columnStachBuilder.GetPackage();
var stachExtension = columnStachBuilder.Build();
var table = stachExtension.ConvertToTable();


// Stach v1 Column Organized format
var columnStachBuilder = StachExtensionFactory.GetColumnOrganizedBuilder<Package>();
columnStachBuilder.SetPackage(data);  // data is the stach input in string or object format
// var package = columnStachBuilder.GetPackage();
var stachExtension = columnStachBuilder.Build();
var table = stachExtension.ConvertToTable();

R

# Column Organized Stach 
package <- read(factset.protobuf.stach.v2.Package,input='local path of your stach extension file')
stachExtensioncol <- factset.protobuf.stachextensions::V2ColumnOrganizedStachExtension$new()

# To get the Column Organized stach data in tabular format with merging the headers 
columnOrganizedData <- stachExtensioncol$ConvertToDataFrame(package)

# To get the Column Organized stach data in tabular format without merging the headers
columnOrganizedData <- stachExtensioncol$ConvertToDataFrame(package,FALSE)

# To get the Column Organized meta data 
columnOrganizedMetadata <- stachExtensioncol$GetMetadata(package)

# Row Organized Stach
package <- read(factset.protobuf.stach.v2.RowOrganizedPackage,input='local path of your stach extension file')
stachExtensionrow <- factset.protobuf.stachextensions::V2RowOrganizedStachExtension$new()

# To get the Row Organized stach data in tabular format with merging the headers
rowOrganizedData <- stachExtensionrow$ConvertToDataFrame(package)

# To get the Row Organized stach data in tabular format without merging the headers
rowOrganizedData <- stachExtensionrow$ConvertToDataFrame(package,FALSE)

# To get the Row Organized meta data 
rowOrganizedMetadata <- stachExtensionrow$GetMetadata(package)

Contributing

Please refer to the CONTRIBUTING file

Copyright

Copyright 2021 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.