Skip to content

Commit 87f94af

Browse files
tracyboehrertracyboehrer
authored
Merge pull request #1171 from microsoft/gary/readme-updates
Updates to readme
2 parents c45a567 + bdf123c commit 87f94af

File tree

1 file changed

+129
-31
lines changed

1 file changed

+129
-31
lines changed

‎README.md

Lines changed: 129 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,143 @@
11
# ![Bot Framework SDK v4 Python](./doc/media/FrameWorkPython.png)
22

3-
### [Click here to find out what's new with Bot Framework](https://docs.microsoft.com/en-us/azure/bot-service/what-is-new?view=azure-bot-service-4.0)
3+
### [What's new with Bot Framework](https://docs.microsoft.com/en-us/azure/bot-service/what-is-new?view=azure-bot-service-4.0)
44

5-
# Bot Framework SDK v4 for Python
6-
[![Build Status](https://fuselabs.visualstudio.com/SDK_v4/_apis/build/status/Python/Python-CI-PR-yaml?branchName=master)](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=771&branchName=master)
7-
[![roadmap badge](https://img.shields.io/badge/visit%20the-roadmap-blue.svg)](https://github.com/Microsoft/botbuilder-python/wiki/Roadmap)
8-
[![Coverage Status](https://coveralls.io/repos/github/microsoft/botbuilder-python/badge.svg?branch=HEAD)](https://coveralls.io/github/microsoft/botbuilder-python?branch=HEAD)
9-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
10-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Microsoft/botbuilder-python/blob/master/LICENSE)
11-
[![Gitter](https://img.shields.io/gitter/room/Microsoft/BotBuilder.svg)](https://gitter.im/Microsoft/BotBuilder)
5+
This repository contains code for the Python version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botframework-sdk), which is part of the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences.
126

13-
This repository contains code for the Python version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botbuilder). The Bot Framework SDK v4 enables developers to model conversation and build sophisticated bot applications using Python. This Python version is GA and ready for production usage.
7+
This SDK enables developers to model conversation and build sophisticated bot applications using Python. SDKs for [JavaScript](https://github.com/Microsoft/botbuilder-js), [.NET](https://github.com/Microsoft/botbuilder-dotnet) and [Java (preview)](https://github.com/Microsoft/botbuilder-java) are also available.
148

15-
This repo is part the [Microsoft Bot Framework](https://github.com/Microsoft/botframework) - a comprehensive framework for building enterprise-grade conversational AI experiences.
9+
To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0).
1610

17-
In addition to the Python SDK, Bot Builder supports creating bots in other popular programming languages like [.Net SDK](https://github.com/Microsoft/botbuilder-dotnet), [JavaScript](https://github.com/Microsoft/botbuilder-js), and [Java](https://github.com/Microsoft/botbuilder-java).
11+
For more information jump to a section below.
1812

19-
To get started see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0) for the v4 SDK.
13+
* [Build status](#build-status)
14+
* [Packages](#packages)
15+
* [Getting started](#getting-started)
16+
* [Getting support and providing feedback](#getting-support-and-providing-feedback)
17+
* [Contributing and our code of conduct](contributing-and-our-code-of-conduct)
18+
* [Reporting security sssues](#reporting-security-issues)
19+
20+
## Build Status
21+
22+
| Branch | Description | Build Status | Coverage Status | Code Style |
23+
|----|---------------|--------------|-----------------|--|
24+
| Master | 4.10.* Preview Builds | [![Build Status](https://fuselabs.visualstudio.com/SDK_v4/_apis/build/status/Python/Python-CI-PR-yaml?branchName=master)](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=771&branchName=master) | [![Coverage Status](https://coveralls.io/repos/github/microsoft/botbuilder-python/badge.svg?branch=HEAD)](https://coveralls.io/github/microsoft/botbuilder-python?branch=HEAD) | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) |
2025

2126
## Packages
2227

23-
- [![PyPI version](https://badge.fury.io/py/botbuilder-ai.svg)](https://pypi.org/project/botbuilder-ai/) botbuilder-ai
24-
- [![PyPI version](https://badge.fury.io/py/botbuilder-applicationinsights.svg)](https://pypi.org/project/botbuilder-applicationinsights/) botbuilder-applicationinsights
25-
- [![PyPI version](https://badge.fury.io/py/botbuilder-azure.svg)](https://pypi.org/project/botbuilder-azure/) botbuilder-azure
26-
- [![PyPI version](https://badge.fury.io/py/botbuilder-core.svg)](https://pypi.org/project/botbuilder-core/) botbuilder-core
27-
- [![PyPI version](https://badge.fury.io/py/botbuilder-dialogs.svg)](https://pypi.org/project/botbuilder-dialogs/) botbuilder-dialogs
28-
- [![PyPI version](https://badge.fury.io/py/botbuilder-schema.svg)](https://pypi.org/project/botbuilder-schema/) botbuilder-schema
29-
- [![PyPI version](https://badge.fury.io/py/botframework-connector.svg)](https://pypi.org/project/botframework-connector/) botframework-connector
30-
31-
## Contributing
32-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
33-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
34-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
35-
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
36-
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
37-
provided by the bot. You will only need to do this once across all repos using our CLA.
38-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
39-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
40-
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
28+
| Build | Released Package |
29+
|----|---------------|
30+
| botbuilder-ai | [![PyPI version](https://badge.fury.io/py/botbuilder-ai.svg)](https://pypi.org/project/botbuilder-ai/) |
31+
| botbuilder-applicationinsights | [![PyPI version](https://badge.fury.io/py/botbuilder-applicationinsights.svg)](https://pypi.org/project/botbuilder-applicationinsights/) |
32+
| botbuilder-azure | [![PyPI version](https://badge.fury.io/py/botbuilder-azure.svg)](https://pypi.org/project/botbuilder-azure/) |
33+
| botbuilder-core | [![PyPI version](https://badge.fury.io/py/botbuilder-core.svg)](https://pypi.org/project/botbuilder-core/) |
34+
| botbuilder-dialogs | [![PyPI version](https://badge.fury.io/py/botbuilder-dialogs.svg)](https://pypi.org/project/botbuilder-dialogs/) |
35+
| botbuilder-schema | [![PyPI version](https://badge.fury.io/py/botbuilder-schema.svg)](https://pypi.org/project/botbuilder-schema/) |
36+
| botframework-connector | [![PyPI version](https://badge.fury.io/py/botframework-connector.svg)](https://pypi.org/project/botframework-connector/) |
37+
38+
## Getting Started
39+
To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0).
40+
41+
The [Bot Framework Samples](https://github.com/microsoft/botbuilder-samples) includes a rich set of samples repository.
42+
43+
If you want to debug an issue, would like to [contribute](#contributing), or understand how the Bot Builder SDK works, instructions for building and testing the SDK are below.
44+
45+
### Prerequisites
46+
- [Git](https://git-scm.com/downloads)
47+
- [Python 3.8.2](https://www.python.org/downloads/)
48+
49+
Python "Virtual Environments" allow Python packages to be installed in an isolated location for a particular application, rather than being installed globally, as such it is common practice to use them. Click [here](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) to learn more about creating _and activating_ Virtual Environments in Python.
50+
51+
### Clone
52+
Clone a copy of the repo:
53+
```bash
54+
git clone https://github.com/Microsoft/botbuilder-python.git
55+
```
56+
Change to the SDK's directory:
57+
```bash
58+
cd botbuilder-python
59+
```
60+
61+
### Using the SDK locally
62+
63+
You will need the following 3 packages installed in your environment:
64+
- [botframework-connector](https://pypi.org/project/botframework-connector/)
65+
- [botbuilder-core](https://pypi.org/project/botbuilder-core/)
66+
- [botbuilder-schema](https://pypi.org/project/botbuilder-schema/)
67+
68+
To use a local copy of the SDK you can link to these packages with the pip -e option.
69+
70+
```bash
71+
pip install -e ./libraries/botbuilder-schema
72+
pip install -e ./libraries/botframework-connector
73+
pip install -e ./libraries/botbuilder-core
74+
pip install -e ./libraries/botbuilder-integration-aiohttp
75+
pip install -e ./libraries/botbuilder-ai
76+
pip install -e ./libraries/botbuilder-applicationinsights
77+
pip install -e ./libraries/botbuilder-integration-applicationinsights-aiohttp
78+
pip install -e ./libraries/botbuilder-dialogs
79+
pip install -e ./libraries/botbuilder-azure
80+
pip install -e ./libraries/botbuilder-adapters-slack
81+
pip install -e ./libraries/botbuilder-testing
82+
```
83+
84+
### Running unit tests
85+
First execute the following command from the root level of the repo:
86+
```bash
87+
pip install -r ./libraries/botframework-connector/tests/requirements.txt
88+
pip install -r ./libraries/botbuilder-core/tests/requirements.txt
89+
pip install -r ./libraries/botbuilder-ai/tests/requirements.txt
90+
```
91+
92+
Then enter run pytest by simply typing it into your CLI:
93+
94+
```bash
95+
pytest
96+
```
97+
98+
This is the expected output:
99+
```bash
100+
============================= test session starts =============================
101+
platform win32 -- Python 3.8.2, pytest-3.4.0, py-1.5.2, pluggy-0.6.0
102+
rootdir: C:\projects\botbuilder-python, inifile:
103+
plugins: cov-2.5.1
104+
...
105+
```
106+
107+
## Getting support and providing feedback
108+
Below are the various channels that are available to you for obtaining support and providing feedback. Please pay carful attention to which channel should be used for which type of content. e.g. general "how do I..." questions should be asked on Stack Overflow, Twitter or Gitter, with GitHub issues being for feature requests and bug reports.
109+
110+
### Github issues
111+
[Github issues](https://github.com/Microsoft/botbuilder-python/issues) should be used for bugs and feature requests.
112+
113+
### Stack overflow
114+
[Stack Overflow](https://stackoverflow.com/questions/tagged/botframework) is a great place for getting high-quality answers. Our support team, as well as many of our community members are already on Stack Overflow providing answers to 'how-to' questions.
115+
116+
### Azure Support
117+
If you issues relates to [Azure Bot Service](https://azure.microsoft.com/en-gb/services/bot-service/), you can take advantage of the available [Azure support options](https://azure.microsoft.com/en-us/support/options/).
118+
119+
### Twitter
120+
We use the [@botframework](https://twitter.com/botframework) account on twitter for announcements and members from the development team watch for tweets for @botframework.
121+
122+
### Gitter Chat Room
123+
The [Gitter Channel](https://gitter.im/Microsoft/BotBuilder) provides a place where the Community can get together and collaborate.
124+
125+
## Contributing and our code of conduct
126+
We welcome contributions and suggestions. Please see our [contributing guidelines](./contributing.md) for more information.
127+
128+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
129+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
130+
[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
41131

42132
## Reporting Security Issues
43-
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [secure@microsoft.com](mailto:secure@microsoft.com). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/default).
133+
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC)
134+
at [secure@microsoft.com](mailto:secure@microsoft.com). You should receive a response within 24 hours. If for some
135+
reason you do not, please follow up via email to ensure we received your original message. Further information,
136+
including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the
137+
[Security TechCenter](https://technet.microsoft.com/en-us/security/default).
44138

45139
Copyright (c) Microsoft Corporation. All rights reserved.
140+
141+
Licensed under the [MIT](./LICENSE.md) License.
142+
143+

0 commit comments

Comments
 (0)