Skip to content

Commit a78d732

Browse files
authored
Merge pull request #6 from hhslepicka/new-readme
DOC: Update README.
2 parents fde612e + 2083fa8 commit a78d732

File tree

1 file changed

+124
-35
lines changed

1 file changed

+124
-35
lines changed

README.md

Lines changed: 124 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,55 @@
33

44
<p align="center">
55
<strong>« Explore Framework <a href="https://botcity-dev.github.io/botcity-framework-web-python/">docs</a> »</strong>
6-
<br>
7-
<br>
8-
<a href="https://github.com/botcity-dev/botcity-framework-web-python/issues/new?template=bug-report.md">Report bug</a>
9-
·
10-
<a href="https://github.com/botcity-dev/botcity-framework-web-python/issues/new?template=feature-request.md&labels=request">Request feature</a>
11-
·
12-
<a href="https://github.com/botcity-dev/botcity-framework-web-python/blob/main/.github/CONTRIBUTING.md">How to Contribute</a>
13-
·
14-
<a href="https://github.com/botcity-dev/botcity-framework-web-python/blob/main/.github/SUPPORT.md">Support</a>
156
</p>
167
</p>
178

189
<br>
1910

20-
# Prerequisites
11+
## Summary <!-- omit in toc -->
12+
13+
- [🤖 Computer-vision based UI Automation](#-computer-vision-based-ui-automation)
14+
- [🐍 Generate Python Code while Interacting with your UI](#-generate-python-code-while-interacting-with-your-ui)
15+
- [🚀 Getting Started](#-getting-started)
16+
- [📦 Prerequisites](#-prerequisites)
17+
- [💫 Installing](#-installing)
18+
- [⭐ Developing Your First Automation](#-developing-your-first-automation)
19+
- [📚 Documentation](#-documentation)
20+
- [💻 Developers Portal](#-developers-portal)
21+
- [💬 Forum](#-forum)
22+
- [🌎 BotCity Automation Platform](#-botcity-automation-platform)
23+
- [1️⃣ All in One Platform](#1️⃣--all-in-one-platform)
24+
- [2️⃣ Deploy with a Single Line](#2️⃣--deploy-with-a-single-line)
25+
- [3️⃣ Manage your Task Queue](#3️⃣--manage-your-task-queue)
26+
- [4️⃣ Manage your Runtime Environments](#4️⃣--manage-your-runtime-environments)
27+
- [5️⃣ Create Alerts and Reports from the Automation Execution](#5️⃣--create-alerts-and-reports-from-the-automation-execution)
28+
- [6️⃣ Create Google Data Studio Dashboards](#6️⃣--create-google-data-studio-dashboards)
29+
- [7️⃣ Create your Community Account](#7️⃣--create-your-community-account)
30+
- [🤝 Contributing to BotCity Framework](#-contributing-to-botcity-framework)
31+
- [⛑ Support](#-support)
32+
- [🐛 Bug reports and 💎 Feature requests](#-bug-reports-and--feature-requests)
33+
- [📢 Contact us](#-contact-us)
34+
- [💡 Related Projects](#-related-projects)
35+
36+
37+
## 🤖 Computer-vision based UI Automation
38+
39+
Recognize and interact with UI elements using state-of-art computer vision module.
40+
41+
Operate any UI interface independent of the technology or platform (desktop, web, terminal).
42+
43+
## 🐍 Generate Python Code while Interacting with your UI
44+
45+
Use our Development Tool alongside your favorite IDE to select UI components and generate python code.
46+
47+
[![BotCity Studio](https://developers.botcity.dev/github/readme/studio/studio.gif)](https://botcity.atlassian.net/l/c/eBJ6bLLV)
48+
49+
[SIGN UP](https://developers.botcity.dev/app/signup) and download our tools.
50+
51+
52+
## 🚀 Getting Started
53+
54+
### 📦 Prerequisites
2155
* Python 3.7+
2256
* botcity-framework-base
2357
* beautifulsoup4
@@ -27,40 +61,95 @@
2761
* pillow
2862
* selenium
2963

30-
Python package requirements are listed in the requirements.txt file, which can
31-
be used to install all requirements from pip: 'pip install -r requirements.txt'
64+
### 💫 Installing
3265

33-
# Running the Tests
34-
In order to run the tests you will need to install some dependencies that are
35-
not part of the runtime dependencies.
66+
```bash
67+
pip install botcity-framework-web
68+
```
3669

37-
Assuming that you have cloned this repository do:
70+
### ⭐ Developing Your First Automation
3871

39-
```bash
40-
pip install -r test-requirements.txt
72+
[![First Automation](https://developers.botcity.dev/github/readme/python-web/firstbot.png)](https://botcity-dev.github.io/botcity-framework-web-python/intro/)
4173

42-
python run_tests.py
43-
```
74+
## 📚 Documentation
4475

45-
# Running the Examples
46-
There are various examples of the features and how to get started.
47-
Check out the examples folder.
76+
Documentation is available at https://botcity-dev.github.io/botcity-framework-web-python.
4877

49-
# Building the Documentation Locally
50-
In order to build the documentation you will need to install some dependencies
51-
that are not part of the runtime dependencies.
78+
## 💻 Developers Portal
5279

53-
Assuming that you have cloned this repository do:
80+
[![Developers Portal](https://developers.botcity.dev/github/readme/portal.png)](https://botcity.atlassian.net/l/c/boMU4TX9)
5481

55-
```bash
56-
pip install -r docs-requirements.txt
82+
## 💬 Forum
5783

58-
mkdocs build
59-
```
84+
[![Forum](https://developers.botcity.dev/github/readme/forum.png)](https://community.botcity.dev/)
6085

61-
This will generate the HTML documentation in the `<>/site`
62-
folder. Look for the `index.html` file and open it with your browser.
86+
## 🌎 BotCity Automation Platform
87+
BotCity is a platform to develop, deploy, manage and maintain automations. Automations can be developed in Python or Java using open-source libraries that are market standard.
6388

64-
# Online Documentation
89+
### 1️⃣ All in One Platform
90+
Develop, deploy, manage and scale your Automation Ops using All in One platform that provides task queue, runtime environment management, reports, alerts, logs and much more.
6591

66-
Documentation is available at https://botcity-dev.github.io/botcity-framework-web-python.
92+
[![BotCity Maestro](https://developers.botcity.dev/github/readme/maestro/maestro.png)](https://botcity.atlassian.net/l/c/WWGswYRX)
93+
94+
### 2️⃣ Deploy with a Single Line
95+
96+
Use BotCity command-line interface (CLI) to deploy your bot into a runtime environment with a single line:
97+
98+
[![BotCity CLI](https://developers.botcity.dev/github/readme/cli/botcli.gif)](https://botcity.atlassian.net/l/c/hJHE1ZFv)
99+
100+
### 3️⃣ Manage your Task Queue
101+
102+
[![BotCity Maestro Task Queue](https://developers.botcity.dev/github/readme/maestro/tasks.png)](https://botcity.atlassian.net/l/c/gR3AAd2a)
103+
104+
### 4️⃣ Manage your Runtime Environments
105+
106+
[![BotCity Maestro Machines](https://developers.botcity.dev/github/readme/maestro/machines.png)](https://botcity.atlassian.net/l/c/uDB087nK)
107+
108+
### 5️⃣ Create Alerts and Reports from the Automation Execution
109+
110+
[![BotCity Maestro Alerts](https://developers.botcity.dev/github/readme/maestro/alerts.png)](https://botcity.atlassian.net/l/c/McH09qYw)
111+
112+
### 6️⃣ Create Google Data Studio Dashboards
113+
114+
[![BotCity Maestro Dashboards](https://developers.botcity.dev/github/readme/maestro/dashboard.png)](https://botcity.atlassian.net/l/c/Z1uMY1vX)
115+
116+
### 7️⃣ Create your Community Account
117+
118+
We have a community account for hobbyists and students. Just signup and start automating.
119+
120+
[![Sign Up](https://developers.botcity.dev/github/readme/signup.png)](https://developers.botcity.dev/app/signup)
121+
122+
123+
## 🤝 Contributing to BotCity Framework
124+
125+
- [Guidelines](https://github.com/botcity-dev/botcity-framework-web-python/blob/main/.github/CONTRIBUTING.md)
126+
- [Documentation](https://botcity-dev.github.io/botcity-framework-web-python/)
127+
128+
## ⛑ Support
129+
130+
### 🐛 Bug reports and 💎 Feature requests
131+
132+
If you spot a problem, please let us know by following the template in
133+
here: [Report a bug](https://github.com/botcity-dev/botcity-framework-web-python/issues/new?template=bug-report.md).
134+
135+
Ideas or suggestions for enhancements are more than welcome. Please use the following
136+
template in here: [Request feature](https://github.com/botcity-dev/botcity-framework-web-python/issues/new?template=feature-request.md&labels=request).
137+
138+
### 📢 Contact us
139+
140+
If you have questions or comments in general about the framework, we want to know.
141+
142+
You can choose between the channels the one that best fit you:
143+
144+
- [BotCity Community](<https://community.botcity.dev>) (Public)
145+
146+
or you can [file a bug](https://github.com/botcity-dev/botcity-framework-web-python/issues/new?template=bug-report.md) and let us know where our documentation could be improved.
147+
148+
## 💡 Related Projects
149+
150+
<a href="https://github.com/botcity-dev/botcity-framework-core-python">
151+
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=botcity-dev&repo=botcity-framework-core-python" />
152+
</a>
153+
<a href="https://github.com/botcity-dev/botcity-maestro-sdk-python">
154+
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=botcity-dev&repo=botcity-maestro-sdk-python" />
155+
</a>

0 commit comments

Comments
 (0)