Moving development to poetry and added workflow

.flake8

@@ -1,3 +0,0 @@
-[flake8]
-ignore=E501,E123,E121,E126,E133,E203,W505,W503,W504
-exclude=.git,__pycache__,pwncat.egg-info,env,dist,build,data,docs,tests,test.py

.github/workflows/publish.yml

@@ -38,6 +38,13 @@ jobs:
           echo "## Changelog" >> this_version_changelog.md
           cat CHANGELOG.md | sed -n '/^## \['"$version"'\]/,/^## /p' | head -n -1 | tail -n +2 >> this_version_changelog.md
           echo "[Full Changelog](https://github.com/calebstewart/pwncat/blob/v$version/CHANGELOG.md)" >> this_version_changelog.md
+      - name: Publish Package to PyPi
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          pip install poetry
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry publish --build
       - name: Publish Plugins
         uses: softprops/action-gh-release@v1
         with:

CHANGELOG.md

@@ -8,12 +8,16 @@ The Changelog starts with v0.4.1, because we did not keep one before that,
 and simply didn't have the time to go back and retroactively create one.
 
 ## [Unreleased]
+### Changed
+- Moved dependency management and building to [Poetry](https://python-poetry.org).
+- Changed package name to `pwncat-cs` in order to not conflict w/ cytopia/pwncat.
 ### Added
 - Added `ssl-bind` and `ssl-connect` channel protocols for encrypted shells
 - Added `ncat`-style ssl arguments to entrypoint and `connect` command
 - Added query-string arguments to connection strings for both the entrypoint
   and the `connect` command.
 - Added Enumeration States to allow session-bound enumerations
+- Added PyPi publishing to GitHub `publish` workflow.
 
 ## [0.4.3] - 2021-06-18
 Patch fix release. Major fixes are the correction of file IO for LinuxWriters and

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Caleb Stewart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyproject.toml

@@ -1,3 +1,9 @@
+
+[tool.flakehell]
+ignore=["E501,E123,E121,E126,E133,E203,W505,W503,W504"]
+exclude=[".git","__pycache__","pwncat.egg-info","env","dist","build","data","docs","tests","test.py"]
+extended_default_ignore = []
+
 [tool.isort]
 profile = "black"
 length_sort = true
@@ -8,3 +14,51 @@ testpaths = [
     "tests",
 ]
 addopts = "-v"
+
+[tool.poetry]
+name = "pwncat-cs"
+version = "0.4.3"
+description = "Reverse and bind shell automation framework"
+authors = ["Caleb Stewart <caleb.stewart94@gmail.com>", "John Hammond"]
+readme = "README.md"
+repository = "https://github.com/calebstewart/pwncat"
+documentation = "https://pwncat.readthedocs.io"
+keywords = ["offsec", "cyber", "exploitation", "privesc", "automation"]
+packages = [
+  { include = "pwncat" },
+]
+license = "MIT"
+
+[tool.poetry.scripts]
+pwncat = "pwncat.__main__:main"
+pcat = "pwncat.__main__:main"
+pc = "pwncat.__main__:main"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/calebstewart/pwncat/issues"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+netifaces = "^0.11.0"
+packaging = "^20.9"
+prompt-toolkit = "^3.0.19"
+pycryptodome = "^3.10.1"
+requests = "^2.25.1"
+rich = "^10.4.0"
+python-rapidjson = "^1.0"
+ZODB3 = "^3.11.0"
+zodburi = "^2.5.0"
+paramiko = "^2.7.2"
+Jinja2 = "^3.0.1"
+
+[tool.poetry.dev-dependencies]
+flakehell = "^0.9.0"
+isort = "^5.8.0"
+pytest = "^6.2.4"
+Sphinx = "^4.0.2"
+sphinx-rtd-theme = "^0.5.2"
+enum-tools = "^0.6.4"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

requirements.txt

@@ -1,11 +0,0 @@
-netifaces==0.10.9
-packaging==20.4
-prompt-toolkit==3.0.5
-pycryptodome==3.9.8
-requests==2.24.0
-rich==9.10.0
-python-rapidjson==0.9.1
-ZODB==5.6.0
-zodburi==2.4.0
-jinja2==3.0.1
-paramiko==2.7.2

setup.py

@@ -1,36 +0,0 @@
-#!/usr/bin/env python
-
-from setuptools import setup, find_packages
-
-dependencies = [
-    "netifaces",
-    "packaging",
-    "prompt-toolkit",
-    "pycryptodome",
-    "requests",
-    "rich",
-    "python-rapidjson",
-    "ZODB",
-    "zodburi",
-    "Jinja2",
-    "paramiko",
-]
-dependency_links = []
-
-# Setup
-setup(
-    name="pwncat",
-    version="0.4.3",
-    python_requires=">=3.8",
-    description="A fancy reverse and bind shell handler",
-    author="Caleb Stewart",
-    url="https://gitlab.com/calebstewart/pwncat",
-    packages=find_packages(),
-    package_data={"pwncat": ["data/*"]},
-    entry_points={
-        "console_scripts": ["pwncat=pwncat.__main__:main", "pc=pwncat.__main__:main"]
-    },
-    data_files=[],
-    install_requires=dependencies,
-    dependency_links=dependency_links,
-)