Skip to content

Commit ecb09ed

Browse files
codeamtcodeamt
committed
updated workflow for public release
1 parent 0d4c8a8 commit ecb09ed

5 files changed

Lines changed: 27 additions & 17 deletions

File tree

pypi-stub/.github/workflows/publish-stub.yml renamed to .github/workflows/publish-stub.yml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,15 @@ on:
66
- "stub-v*"
77
workflow_dispatch:
88

9+
concurrency:
10+
group: pypi-stub-publish
11+
cancel-in-progress: false
12+
913
jobs:
1014
publish:
1115
name: Build and Publish Stub
1216
runs-on: ubuntu-latest
17+
environment: pypi
1318
permissions:
1419
contents: read
1520

@@ -42,10 +47,11 @@ jobs:
4247
4348
# Must include required policy/doc files
4449
test -f pyproject.toml || { echo "Missing pyproject.toml"; exit 1; }
45-
test -f README.md || { echo "Missing README.md"; exit 1; }
50+
test -f LICENSE || { echo "Missing LICENSE"; exit 1; }
51+
test -f STUB-README.md || { echo "Missing STUB-README.md"; exit 1; }
4652
test -f ../SECURITY.md || { echo "Missing SECURITY.md in repo root"; exit 1; }
4753
test -f ../LICENSE-APPENDIX.md || { echo "Missing LICENSE-APPENDIX.md in repo root"; exit 1; }
48-
test -f ../pe_packer_stub.py || { echo "Missing pe_packer_stub.py in repo root"; exit 1; }
54+
test -f pe_packer_stub.py || { echo "Missing pe_packer_stub.py in pypi-stub directory"; exit 1; }
4955
5056
- name: Guarded release gate
5157
run: |
@@ -59,6 +65,10 @@ jobs:
5965
python -m pip install --upgrade pip
6066
python -m pip install build twine
6167
68+
- name: Prepare license and security docs
69+
run: |
70+
cp LICENSE SECURITY.md LICENSE-APPENDIX.md pypi-stub/
71+
6272
- name: Build wheel and sdist
6373
working-directory: pypi-stub
6474
run: |

pypi-stub/README.md renamed to pypi-stub/STUB-README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ This package is an educational metadata stub published to PyPI. It contains **no
1010

1111
The educational source and instructions are available at:
1212

13-
https://github.com/codeamt/pe-packer
13+
https://github.com/codeamt/rust-python-pe-packer
1414

1515
You can install straight from source (safe-by-default):
1616

1717
```bash
18-
pip install git+https://github.com/codeamt/pe-packer
18+
pip install git+https://github.com/codeamt/rust-python-pe-packer
1919
```
2020

2121
## Responsible Use

‎pypi-stub/pe_packer_stub.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ def main() -> None:
1010
This PyPI package does not contain functional packing code.
1111
1212
Educational source and instructions:
13-
https://github.com/codeamt/pe-packer
13+
https://github.com/codeamt/rust-python-pe-packer
1414
1515
Safe install from source (non-functional by default):
16-
pip install git+https://github.com/codeamt/pe-packer
16+
pip install git+https://github.com/codeamt/rust-python-pe-packer
1717
1818
All packing functions are disabled by default and require explicit opt-in.
1919
See SECURITY.md and LICENSE-APPENDIX.md for details.

‎pypi-stub/pyproject.toml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ requires = ["hatchling>=1.18"]
33
build-backend = "hatchling.build"
44

55
[project]
6-
name = "pe-packer-educational"
6+
name = "rust-python-pe-packer"
77
version = "0.0.1"
8-
description = "Educational PE (Portable Executable) learning stub. No packing functionality. See SECURITY.md."
9-
readme = "README.md"
8+
description = "Educational Rust/Python PE (Portable Executable) learning stub. No packing functionality. See SECURITY.md."
9+
readme = "STUB-README.md"
1010
requires-python = ">=3.8"
11-
license = { text = "MIT OR Apache-2.0; see LICENSE-APPENDIX.md for educational-use clarifications" }
11+
license = { text = "Apache-2.0; see LICENSE-APPENDIX.md for educational-use clarifications" }
1212
authors = [
1313
{ name = "AnnMargaret Tutu", email = "annmargaret.mailforce@gmail.com" }
1414
]
@@ -23,7 +23,6 @@ keywords = [
2323
classifiers = [
2424
"Development Status :: 3 - Alpha",
2525
"Intended Audience :: Education",
26-
"License :: OSI Approved :: MIT License",
2726
"License :: OSI Approved :: Apache Software License",
2827
"Programming Language :: Python :: 3",
2928
"Programming Language :: Python :: 3 :: Only",
@@ -38,15 +37,16 @@ dependencies = []
3837
pe-packer = "pe_packer_stub:main"
3938

4039
[project.urls]
41-
Homepage = "https://github.com/codeamt/pe-packer"
42-
Documentation = "https://github.com/codeamt/pe-packer#readme"
43-
Security = "https://github.com/codeamt/pe-packer/blob/main/SECURITY.md"
44-
License = "https://github.com/codeamt/pe-packer/blob/main/LICENSE-APPENDIX.md"
40+
Homepage = "https://github.com/codeamt/rust-python-pe-packer"
41+
Documentation = "https://github.com/codeamt/rust-python-pe-packer#readme"
42+
Security = "https://github.com/codeamt/rust-python-pe-packer/blob/main/SECURITY.md"
43+
License = "https://github.com/codeamt/rust-python-pe-packer/blob/main/LICENSE-APPENDIX.md"
4544

4645
[tool.hatch.build]
4746
include = [
4847
"pe_packer_stub.py",
49-
"README.md",
48+
"LICENSE",
49+
"STUB-README.md",
5050
"SECURITY.md",
5151
"LICENSE-APPENDIX.md"
5252
]

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "maturin"
44

55
[project]
66
name = "rust-python-pe-packer"
7-
description = "Educational PE packer with Python bindings for malware detection training"
7+
description = "Educational Rust/Python PE packer with Python bindings for malware detection training"
88
readme = "README.md"
99
requires-python = ">=3.8"
1010
license = { text = """

0 commit comments

Comments
 (0)