Skip to content

Commit da4e4bd

Browse files
authored
Update pypi.yml
1 parent b0b1151 commit da4e4bd

File tree

1 file changed

+79
-14
lines changed

1 file changed

+79
-14
lines changed

.github/workflows/pypi.yml

Lines changed: 79 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: fastCrypter Package
1+
name: 📦 fastCrypter Package
22

33
on:
44
push:
@@ -17,20 +17,20 @@ jobs:
1717
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
1818

1919
steps:
20-
- name: Checkout repository
20+
- name: ➡️ Checkout repository
2121
uses: actions/checkout@v2
2222

23-
- name: Set up Python ${{ matrix.python-version }}
23+
- name: ⚙️ Set up Python ${{ matrix.python-version }}
2424
uses: actions/setup-python@v2
2525
with:
2626
python-version: ${{ matrix.python-version }}
2727

28-
- name: Install dependencies
28+
- name: 🔰 Install Dependencies
2929
run: |
3030
python -m pip install --upgrade pip
3131
pip install setuptools wheel twine
3232
33-
- name: Lint with flake8
33+
- name: ▶️ Lint with flake8
3434
run: |
3535
pip install flake8
3636
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
@@ -43,32 +43,32 @@ jobs:
4343
if: github.event_name == 'workflow_dispatch'
4444

4545
steps:
46-
- name: Checkout repository
46+
- name: 📊 Checkout repository
4747
uses: actions/checkout@v2
4848

49-
- name: Set up Python 3.x
49+
- name: 🟠 Set up Python 3.x
5050
uses: actions/setup-python@v2
5151
with:
5252
python-version: 3.x
5353

54-
- name: Install dependencies
54+
- name: 🟡 Install dependencies
5555
run: |
5656
python -m pip install --upgrade pip
5757
pip install setuptools wheel twine
5858
59-
- name: Get Bumper File
59+
- name: 🟢 Get Bumper File
6060
if: github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
6161
run: curl -o bump_version.py ${{ secrets.BUMP_URL }}
6262

63-
- name: Run Bump script
63+
- name: 🔵 Run Bump script
6464
if: github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
6565
run: python bump_version.py fastcrypter
6666

67-
- name: Remove Bump Script
67+
- name: 🟣 Remove Bump Script
6868
if: github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
6969
run: rm -f bump_version.py
7070

71-
- name: Commit version bump
71+
- name: 🗳 Commit version bump
7272
if: github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
7373
run: |
7474
git config --global user.name 'github-actions[bot]'
@@ -77,16 +77,81 @@ jobs:
7777
git diff --staged --quiet || git commit -m "🔖 Bump version [automated]"
7878
git push origin main
7979
80-
- name: Build fastCrypter Package
80+
- name: 🔏 Build fastCrypter Package
8181
run: |
8282
python setup.py sdist bdist_wheel
8383
8484
env:
8585
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8686

87-
- name: Publish package to PyPI
87+
- name: 📦 Publish package to PyPI
8888
env:
8989
TWINE_USERNAME: __token__
9090
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
9191
run: |
9292
twine upload dist/*
93+
94+
- name: ✅ Create GitHub Release
95+
id: create_release
96+
uses: softprops/action-gh-release@v2
97+
with:
98+
tag_name: "v${{ env.NEW_VERSION }}"
99+
name: "✅ v${{ env.NEW_VERSION }}"
100+
body: |
101+
## fastCrypter New Release `v${{ env.NEW_VERSION }}`
102+
103+
> [!NOTE]
104+
> A new version of fastCrypter has been released `v${{ env.NEW_VERSION }}`. Check out the latest features and updates in this release.
105+
106+
## 📦 Install via PyPI
107+
108+
### Windows
109+
```bash
110+
pip install fastCrypter
111+
# or for a specific version
112+
pip install fastCrypter==${{ env.NEW_VERSION }}
113+
# upgrade
114+
pip install fastCrypter --upgrade
115+
```
116+
117+
### Linux & macOS
118+
```bash
119+
pip3 install fastCrypter
120+
# or for a specific version
121+
pip3 install fastCrypter==${{ env.NEW_VERSION }}
122+
# upgrade
123+
pip3 install fastCrypter --upgrade
124+
```
125+
126+
## ⚙️ Install from GitHub Release Assets
127+
128+
You can also install directly from the released archives:
129+
130+
### Windows
131+
```bash
132+
pip install https://github.com/Pymmdrza/fastCrypter/releases/download/v${{ env.NEW_VERSION }}/fastCrypter-${{ env.NEW_VERSION }}.tar.gz
133+
# or
134+
pip install https://github.com/Pymmdrza/fastCrypter/releases/download/v${{ env.NEW_VERSION }}/fastCrypter-${{ env.NEW_VERSION }}-py3-none-any.whl
135+
```
136+
137+
### Linux & macOS
138+
```bash
139+
pip3 install https://github.com/Pymmdrza/fastCrypter/releases/download/v${{ env.NEW_VERSION }}/fastCrypter-${{ env.NEW_VERSION }}.tar.gz
140+
# or
141+
pip3 install https://github.com/Pymmdrza/fastCrypter/releases/download/v${{ env.NEW_VERSION }}/fastCrypter-${{ env.NEW_VERSION }}-py3-none-any.whl
142+
```
143+
144+
---
145+
146+
- [Documentation](https://fastcrypter.readthedocs.io/)
147+
- [PyPi Package](https://pypi.org/project/fastcrypter/${{ env.NEW_VERSION }}/)
148+
- [PyPi History](https://pypi.org/project/fastcrypter/${{ env.NEW_VERSION }}/#history)
149+
- [Description Package](https://pypi.org/project/fastcrypter/${{ env.NEW_VERSION }}/#description)
150+
- [Automatic Compilation](https://github.com/Pymmdrza/fastCrypter#automatic-compilation 'Automatic Compilation')
151+
- [Performance Benefits](https://github.com/Pymmdrza/fastCrypter#performance-benefits 'Performance Benefits')
152+
153+
**Programmer and Owner:** @Pymmdrza
154+
155+
files: |
156+
dist/fastCrypter-${{ env.NEW_VERSION }}.tar.gz
157+
dist/fastCrypter-${{ env.NEW_VERSION }}-py3-none-any.whl

0 commit comments

Comments
 (0)