Skip to content

Commit 06a8a8e

Browse files
committed
DOC: Add word about using as script and via bot class.
CI: Prepare for transfer of ownership.
1 parent cd688af commit 06a8a8e

File tree

4 files changed

+47
-2
lines changed

4 files changed

+47
-2
lines changed

.github/workflows/gh-pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88

99
jobs:
1010
deploy:
11-
if: ${{ github.repository == 'hhslepicka/botcity-framework-core-python' }}
11+
if: ${{ github.repository == 'botcity-dev/botcity-framework-core-python' }}
1212
runs-on: ${{ matrix.os }}
1313
strategy:
1414
matrix:

.github/workflows/pypi_upload.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Publish Python distributions to PyPI
2+
3+
on: push
4+
5+
jobs:
6+
build-n-publish:
7+
name: Build and publish Python distributions to PyPI
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@master
12+
with:
13+
fetch-depth: 0
14+
- name: Set up Python 3.7
15+
uses: actions/setup-python@v1
16+
with:
17+
python-version: 3.7
18+
- name: Install pypa/build
19+
run: >-
20+
python -m
21+
pip install
22+
build
23+
--user
24+
- name: Build a source tarball
25+
run: >-
26+
python -m
27+
build
28+
--sdist
29+
--outdir dist/
30+
.
31+
- name: Publish distribution to PyPI
32+
if: startsWith(github.ref, 'refs/tags')
33+
uses: pypa/gh-action-pypi-publish@master
34+
with:
35+
password: ${{ secrets.PYPI_API_TOKEN }}

docs/intro.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ which takes as argument a URL.
1919
browser("https://www.botcity.dev/en")
2020
```
2121

22+
You can use this framework in two ways:
23+
24+
- Scripting using the functions
25+
- Creating a Bot class
26+
27+
The second method is the best if you plan to integrate your bot with the BotCity Maestro SDK.
28+
The template project uses the Bot class and the examples cover both approaches.
29+
2230
## Template Project
2331

2432
We created a template project using Cookiecutter to help
@@ -31,3 +39,5 @@ on how to use it and get started.
3139

3240
Check our examples and experiment with the API.
3341
Let us know where it can be improved.
42+
43+
Have fun automating!

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
version=versioneer.get_version(),
1313
cmdclass=versioneer.get_cmdclass(),
1414
packages=find_namespace_packages(include=['botcity.*']),
15-
url='https://www.botcity.dev/',
15+
url='https://www.github.com/botcity-dev/botcity-framework-core-python',
1616
long_description=open('README.md').read(),
1717
long_description_content_type='text/markdown',
1818
install_requires=requirements,

0 commit comments

Comments
 (0)