Skip to content

Updating readme. #19177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Laurent Mazuel (lmazuel) merged 3 commits into from
Jun 18, 2021
Merged

Updating readme. #19177

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4687ea1
Updating readme.
agniveshadhikari Jun 9, 2021
deac8eb
Added link
agniveshadhikari Jun 9, 2021
6a43a44
fix typo
agniveshadhikari Jun 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions sdk/agrifood/azure-agrifood-farming/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure AgriFood Farming client library for Python
# Azure FarmBeats client library for Python

@iscai-msft iscai-msft Jun 17, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this should stay AgriFood Farming since that's the name of the package, but also it's your service, so I shall leave it to your discretion

@iscai-msft iscai-msft Jun 17, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc Laurent Mazuel (@lmazuel) in case he's interested

@RGKarthik Karthik RG (RGKarthik) Jun 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While AgriFood farming is the package name, the commercial product name is FarmBeats. We want SEO optimization geared towards the latter. Hence, prefer Farmbeats.

FarmBeats is a B2B PaaS offering from Microsoft that makes it easy for AgriFood companies to build intelligent digital agriculture solutions on Azure. FarmBeats allows users to acquire, aggregate, and process agricultural data from various sources (farm equipment, weather, satellite) without the need to invest in deep data engineering resources.  Customers can build SaaS solutions on top of FarmBeats and leverage first class support for model building to generate insights at scale.

Use FarmBeats client library for Python to do the following.
Expand All @@ -15,12 +15,12 @@ Use FarmBeats client library for Python to do the following.

To use this package, you must have:
- Azure subscription - [Create a free account][azure_subscription]
- AgriFood (FarmBeats) resource - [Install FarmBeats][install_farmbeats]
- Azure FarmBeats resource - [Install FarmBeats][install_farmbeats]
- Python 2.7, 3.6 or later - [Install Python][python]

### Install the package

Install the Azure AgriFood Farming client library for Python with [pip][pip]:
Install the Azure FarmBeats client library for Python with [pip][pip]:

```bash
pip install azure-agrifood-farming
Expand All @@ -33,7 +33,8 @@ provide an instance of the desired credential type obtained from the
[azure-identity][azure_identity_credentials] library.

To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] and
enable AAD authentication on your AgriFood resource (ADD LINK).
enable AAD authentication on your FarmBeats resource. If you followed the [installation docs][install_farmbeats] when creating the FarmBeats
resource, this is already covered.

After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
As an example, [DefaultAzureCredential][default_azure_credential]
Expand Down Expand Up @@ -289,7 +290,7 @@ for scene in scenes:

### General

The AgriFood Farming client will raise exceptions defined in [Azure Core][azure_core] if you call `.raise_for_status()` on your responses.
The FarmBeats client will raise exceptions defined in [Azure Core][azure_core] if you call `.raise_for_status()` on your responses.

### Logging

Expand Down