Before you do this, see installation details:
<aside> 💡 Note that this structure is not the exact structure you need, but is necessary to run this quick-start!
</aside>
CherryBlossom_QuickStart/
├── QuickStart.py
└── Data/
# bash code:
mkdir CherryBlossom_QuickStart
cd CherryBlossom_QuickStart
touch QuickStart.py # add the code to this file afterwards
mkdir Data
mv <relative-path-to-unizipped-data-package>/* ./Data/
# add code to QuickStart.py
python QuickStart.py
# import cherryblossom as a module with the alias 'cb'
# using an alias is optional, but you must use it throughout your code
import cherryblossom as cb
# initialize a Data object from the cherryblossom module
# indicate that the Data is found in the ./Data directory
data = cb.Data('./Data')
# initialize a timezone object with the local timezone
# see documentation on specifiying timezones
tz = cb.Timezone('LOCAL')
# initialize a channels object with the timezone and data objects
# see documentation on specifying specific channels using the 'channels' param
channels = cb.Channels(tz = tz, data = data)
# initialize a channels object with the timezone and channels objects
# see documentation on specifying a time period using the 'period' param
an = cb.Analyzer(tz = tz, channels = channels)
# print a brief analysis of your messages based on the passed objects
an.analyze()
an.analyze_text()
# make a reference to the generated overall DataFrame from the Analyzer obj
df = an.mega
# generate 'scores' from your data, which will be used to connect
blossom_scores = an.form_data(df)
# generate 'scores' from your data, which will be used to generate insights
insights_scores = an.form_minmax_data(df)
# print insights based on your scores
insights = an.insights(insights_scores)
print(insights)
# create a blossom object that will be used to contribute and connect
blossom = cb.Blossom()
blossom.set_data(blossom_scores)
blossom.contribute()
blossom.connect(name = '<your name>', email = '<your email>')