7.2 KiB
| title | keywords | author | ms.author | ms.date | ms.topic | ms.prod | ms.technology | ms.devlang | ms.service |
|---|---|---|---|---|---|---|---|---|---|
| Azure Batch client library for Python | Azure, java, SDK, API, azure-sdk-template, | maggiepint | magpint | 07/29/2020 | article | azure | azure | java |
README.md template
Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See README-EXAMPLE.md for an example following this template.
Title: The H1 of your README should be in the format: # [Product Name] client library for [Language]
- All headings, including the H1, should use sentence-style capitalization. Refer to the Microsoft Style Guide and Microsoft Cloud Style Guide for more information.
- Example: `# Azure Batch client library for Python - Version 1.1.0
Introduction: The introduction appears directly under the title (H1) of your README.
-
DO NOT use an "Introduction" or "Overview" heading (H2) for this section.
-
First sentence: Describe the service briefly. You can usually use the first line of the service's docs landing page for this (Example: Cosmos DB docs landing page).
-
Next, add a bulleted list of the most common tasks supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the Examples section later in the document. Keep the task list short but include those tasks most developers need to perform with your package.
-
Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi):
Source code | Package (PyPi) | API reference documentation | Product documentation
TIP: Your README should be as brief as possible but no more brief than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully.
Getting started
This section should include everything a developer needs to do to install and create their first client connection very quickly.
Install the package
First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like pip install package-name, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository.
Include a Prerequisites line after the install command that details any requirements that must be satisfied before a developer can authenticate and test all of the snippets in the Examples section. For example, for Cosmos DB:
Prerequisites: You must have an Azure subscription, Cosmos DB account (SQL API), and Python 3.6+ to use this package.
Authenticate the client
If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating.
For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object.
Key concepts
The Key concepts section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity.
Examples
Include code snippets and short descriptions for each task you listed in the Introduction (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations.
If possible, use the same example snippets that your in-code documentation uses. For example, use the snippets in your examples.py that Sphinx ingests via its literalinclude directive. The examples.py file containing the snippets should reside alongside your package's code, and should be tested in an automated fashion.
Each example in the Examples section starts with an H3 that describes the example. At the top of this section, just under the Examples H2, add a bulleted list linking to each example H3. Each example should deep-link to the types and/or members used in the example.
Create the thing
Use the create_thing method to create a Thing reference; this method does not make a network call. To persist the Thing in the service, call Thing.save.
thing = client.create_thing(id, name)
thing.save()
Get the thing
The get_thing method retrieves a Thing from the service. The id parameter is the unique ID of the Thing, not its "name" property.
thing = client.get_thing(id)
List the things
Use list_things to get one or more Thing objects from the service. If there are no Things available, a 404 exception is thrown (see Troubleshooting for details on handling exceptions).
things = client.list_things()
Troubleshooting
Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery.
Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API.
If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code.
Next steps
- Provide a link to additional code examples, ideally to those sitting alongside the README in the package's
/samplesdirectory. - If appropriate, point users to other packages that might be useful.
- If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for.
