Skip to content

Commit d6a8027

Browse files
committed
Add general installation instruction, add workflow to publish package on pypi.
1 parent d492ef4 commit d6a8027

File tree

2 files changed

+34
-3
lines changed

2 files changed

+34
-3
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# This workflow will upload a Python Package using Twine when a release is created
2+
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3+
4+
name: Upload Python Package
5+
6+
on:
7+
release:
8+
types: [created]
9+
10+
jobs:
11+
deploy:
12+
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up Python
18+
uses: actions/setup-python@v2
19+
with:
20+
python-version: '3.x'
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install setuptools wheel twine
25+
- name: Build and publish
26+
env:
27+
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
28+
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
29+
run: |
30+
python setup.py sdist bdist_wheel
31+
twine upload dist/*

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,20 @@ This library is still under development. API can change.
3434
Install Visual-dialog using `pip` (The lib is not yet available on **pypi**):
3535

3636
```sh
37-
python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog
37+
pip install git+git://github.com/Tim-ats-d/Visual-dialog
3838
```
3939
or update lib to the latest version:
4040

4141
```sh
42-
python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog --upgrade
42+
pip install git+git://github.com/Tim-ats-d/Visual-dialog --upgrade
4343
```
4444

4545
### From source
4646

4747
```sh
4848
git clone https://github.com/Tim-ats-d/Visual-dialog.git
4949
cd Visual-dialog
50-
python3 -m pip install .
50+
pip install .
5151
```
5252

5353
## Requirements

0 commit comments

Comments
 (0)