.. _intro_start:
|BuildStatus| |CoverageStatus| |Codacy| |Docs| |PyPi| |License|
|Brand| is a a data analysis tool used for quickly building charts, tables, reports, and dashboards. It defines a schema for configuring metrics and dimensions which removes most of the leg work of writing queries and formatting charts. |Brand| even works great with Jupyter notebooks and in the Python shell providing quick and easy access to your data.
.. _intro_end:
Read more at http://fireant.readthedocs.io/en/latest/
.. _installation_start:
To install |Brand|, run the following command in the terminal:
.. code-block:: bash
pip install fireant
.. _installation_end:
|Brand| arose out of an environment where several different teams, each working with data sets often with crossover, were individually building their own dashboard platforms. |Brand| was developed as a centralized way of building dashboards without the legwork.
|Brand| is used to create configurations of data sets using |FeatureDataSet| which backs a database table containing analytics and defines sets of |FeatureField|. A |FeatureField| can be used to group data by properties, such as a timestamp, an account, a device type, etc, or to render quantifiers such as clicks, ROI, conversions into a widget such as a chart or table.
A |FeatureDataSet| exposes a rich builder API that allows a wide range of queries to be constructed that can be rendered as several widgets. A |FeatureDataSet| can be used directly in a Jupyter_ notebook, eliminating the need to write repetitive custom queries and render the data in visualizations.
|FeatureDataSet| are the core component of |Brand|. A |FeatureDataSet| is a representation of a data set and is used to execute queries and transform result sets into widgets such as charts or tables.
A |FeatureDataSet| requires only a couple of definitions in order to use: A database connector, a database table, join tables, and dimensions and metrics. Metrics and Dimension definitions tell |Brand| how to query and use data in widgets. Once a dataset is created, it's query API can be used to build queries with just a few lines of code selecting which dimensions and metrics to use and how to filter the data.
.. _dataset_example_start:
Instantiating a Data Set """"""""""""""""""""""""
.. code-block:: python
from fireant.dataset import *
from fireant.database import VerticaDatabase
from pypika import Tables, functions as fn
vertica_database = VerticaDatabase(user='myuser', password='mypassword')
analytics, customers = Tables('analytics', 'customers')
my_dataset = DataSet(
database=vertica_database,
table=analytics,
fields=[
Field(
# Non-aggregate definition
alias='customer',
definition=customers.id,
label='Customer'
),
Field(
# Date/Time type, also non-aggregate
alias='date',
definition=analytics.timestamp,
type=DataType.date,
label='Date'
),
Field(
# Text type, also non-aggregate
alias='device_type',
definition=analytics.device_type,
type=DataType.text,
label='Device_type'
),
Field(
# Aggregate definition (The SUM function aggregates a group of values into a single value)
alias='clicks',
definition=fn.Sum(analytics.clicks),
label='Clicks'
),
Field(
# Aggregate definition (The SUM function aggregates a group of values into a single value)
alias='customer-spend-per-clicks',
definition=fn.Sum(analytics.customer_spend / analytics.clicks),
type=DataType.number,
label='Spend / Clicks'
)
],
joins=[
Join(customers, analytics.customer_id == customers.id),
],
.. _dataset_example_end:
.. _dataset_query_example_start:
Building queries with a Data Set """"""""""""""""""""""""""""""""
Use the query property of a data set instance to start building a data set query. A data set query allows method calls to be chained together to select what should be included in the result.
This example uses the data set defined above
.. code-block:: python
from fireant import Matplotlib, Pandas, day
matplotlib_chart, pandas_df = my_dataset.data \
.dimension(
# Select the date dimension with a daily interval to group the data by the day applies to
# dimensions are referenced by `dataset.fields.{alias}`
day(my_dataset.fields.date),
# Select the device_type dimension to break the data down further by which device it applies to
my_dataset.fields.device_type,
) \
.filter(
# Filter the result set to data to the year of 2018
my_dataset.fields.date.between(date(2018, 1, 1), date(2018, 12, 31))
) \
# Add a week over week reference to compare data to values from the week prior
.reference(WeekOverWeek(dataset.fields.date))
.widget(
# Add a matpotlib chart widget
Matplotlib()
# Add axes with series to the chart
.axis(Matplotlib.LineSeries(dataset.fields.clicks))
# metrics are referenced by `dataset.metrics.{alias}`
.axis(Matplotlib.ColumnSeries(
my_dataset.fields['customer-spend-per-clicks']
))
) \
.widget(
# Add a pandas data frame table widget
Pandas(
my_dataset.fields.clicks,
my_dataset.fields['customer-spend-per-clicks']
)
) \
.fetch()
# Display the chart
matplotlib_chart.plot()
# Display the chart
print(pandas_df)
.. _dataset_query_example_end:
Copyright 2020 KAYAK Germany, GmbH
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.
Crafted with ♥ in Berlin.
.. _license_end:
.. _available_badges_start:
.. |BuildStatus| image:: https://travis-ci.org/kayak/fireant.svg?branch=master :target: https://travis-ci.org/kayak/fireant .. |CoverageStatus| image:: https://coveralls.io/repos/kayak/fireant/badge.svg?branch=master&service=github :target: https://coveralls.io/github/kayak/fireant?branch=master .. |Codacy| image:: https://api.codacy.com/project/badge/Grade/832b5a7dda8949c3b2ede28deada4569 :target: https://www.codacy.com/app/twheys/fireant .. |Docs| image:: https://readthedocs.org/projects/fireant/badge/?version=latest :target: http://fireant.readthedocs.io/en/latest/ .. |PyPi| image:: https://img.shields.io/pypi/v/fireant.svg?style=flat :target: https://pypi.python.org/pypi/fireant .. |License| image:: https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000 :target: http://www.apache.org/licenses/LICENSE-2.0
.. _available_badges_end:
.. _appendix_start:
.. |Brand| replace:: fireant
.. |FeatureDataSet| replace:: DataSet .. |FeatureField| replace:: Field .. |FeatureFilter| replace:: Filter .. |FeatureReference| replace:: Reference .. |FeatureOperation| replace:: Operation
.. |ClassDataSet| replace:: fireant.DataSet <fireant.dataset.klass.DataSet>
.. |ClassDatabase| replace:: fireant.database.Database <fireant.database.base.Database>
.. |ClassJoin| replace:: fireant.Join <fireant.dataset.joins.Join>
.. |ClassMetric| replace:: fireant.Field <fireant.dataset.fields.Field>
.. |ClassThreadPoolConcurrencyMiddleware| replace:: fireant.middleware.ThreadPoolConcurrencyMiddleware <fireant.middleware.concurrency.ThreadPoolConcurrencyMiddleware>
.. |ClassBaseConcurrencyMiddleware| replace:: fireant.middleware.BaseConcurrencyMiddleware <fireant.middleware.concurrency.BaseConcurrencyMiddleware>
.. |ClassBooleanDimension| replace:: fireant.dataset.dimensions.BooleanDimension
.. |ClassContDimension| replace:: fireant.dataset.dimensions.ContinuousDimension
.. |ClassDateDimension| replace:: fireant.dataset.dimensions.DatetimeDimension
.. |ClassCatDimension| replace:: fireant.dataset.dimensions.CategoricalDimension
.. |ClassUniqueDimension| replace:: fireant.dataset.dimensions.UniqueDimension
.. |ClassDisplayDimension| replace:: fireant.dataset.dimensions.DisplayDimension
.. |ClassFilter| replace:: fireant.dataset.filters.Filter
.. |ClassComparatorFilter| replace:: fireant.dataset.filters.ComparatorFilter
.. |ClassBooleanFilter| replace:: fireant.dataset.filters.BooleanFilter
.. |ClassContainsFilter| replace:: fireant.dataset.filters.ContainsFilter
.. |ClassExcludesFilter| replace:: fireant.dataset.filters.ExcludesFilter
.. |ClassRangeFilter| replace:: fireant.dataset.filters.RangeFilter
.. |ClassPatternFilter| replace:: fireant.dataset.filters.PatternFilter
.. |ClassAntiPatternFilter| replace:: fireant.dataset.filters.AntiPatternFilter
.. |ClassReference| replace:: fireant.dataset.references.Reference
.. |ClassWidget| replace:: fireant.widgets.base.Widget
.. |ClassPandasWidget| replace:: fireant.widgets.pandas.Pandas
.. |ClassHighChartsWidget| replace:: fireant.widgets.highcharts.HighCharts <fireant.widgets.highcharts.HighCharts>
.. |ClassHighChartsSeries| replace:: fireant.widgets.highcharts.Series <fireant.widgets.chart_base.Series>
.. |ClassOperation| replace:: fireant.dataset.operations.Operation
.. |ClassVerticaDatabase| replace:: fireant.database.VerticaDatabase
.. |ClassMySQLDatabase| replace:: fireant.database.MySQLDatabase
.. |ClassPostgreSQLDatabase| replace:: fireant.database.PostgreSQLDatabase
.. |ClassRedshiftDatabase| replace:: fireant.database.RedshiftDatabase
.. |ClassDatetimeInterval| replace:: fireant.DatetimeInterval <fireant.dataset.intervals.DatetimeInterval>
.. |ClassTable| replace:: pypika.Table
.. |ClassTables| replace:: pypika.Tables
.. _PyPika: https://github.com/kayak/pypika/ .. _Pandas: http://pandas.pydata.org/ .. _Jupyter: http://jupyter.org/ .. _Matplotlib: http://matplotlib.org/ .. _HighCharts: http://www.highcharts.com/ .. _React-Table: https://react-table.js.org/
.. _appendix_end:
FAQs
Unknown package
We found that fireant demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.