v0.0.12

Author: nikolasfil

.gitignore

@@ -2,3 +2,4 @@ __pycache__
 **/__pycache__/*
 temp/*
 venv_*
+.env

Makefile

@@ -0,0 +1,207 @@
+VENV_DIR=venvs/venv_app
+PYTHON=python3
+SHELL := /bin/bash
+
+
+all: setup
+
+
+# ╔═══════════════════════════════╗
+# ║ Virtual Environment Functions ║
+# ╚═══════════════════════════════╝
+
+# Creates the virtual envirnoment folder and immediately gives them a gitignore
+$(VENV_DIR):
+	@mkdir -p $(VENV_DIR)
+	@echo "*" > $(VENV_DIR)/.gitignore 
+	@echo "Created virtual environment directory $(VENV_DIR)"
+
+create-venv: $(VENV_DIR)
+	@$(PYTHON) -m venv $(VENV_DIR) 
+	@echo "Virtual environment created in $(VENV_DIR)"
+
+clean-venv:
+	@rm -rf $(VENV_DIR)
+	@echo "Removed virtual environment"
+
+venv-upgrade-pip:  
+	@source $(VENV_DIR)/bin/activate && pip install --upgrade pip 
+
+
+venv-copy:
+	@echo "source $(VENV_DIR)/bin/activate" | xsel -ib 
+
+# ╔═══════════════════════════════════════════════╗
+# ║ Extra functions for extra packages to install ║
+# ╚═══════════════════════════════════════════════╝
+ 
+
+
+install-pack-dev:
+	@source $(VENV_DIR)/bin/activate && pip install --editable .
+
+install-req-dev:
+	@source $(VENV_DIR)/bin/activate && pip install -e .[dev]
+	@echo "Development dependencies installed."
+
+install-req-docs:
+	@source $(VENV_DIR)/bin/activate && pip install -e .[docs]
+	@echo "Documentation dependencies installed."
+
+install-req-all:
+	@source $(VENV_DIR)/bin/activate && pip install -e .[dev,docs]
+	@echo "All dependencies installed."
+
+
+# ╔══════════════════════════════════╗
+# ║ All in one create venv and setup ║
+# ╚══════════════════════════════════╝
+
+setup-all-dev: create-venv venv-upgrade-pip install-dev
+	@echo "All development setup steps completed."
+
+setup: create-venv venv-upgrade-pip install
+	@echo "All setup steps completed."
+
+
+
+# Install the package in editable mode for development process 
+install-dev: 
+	@source $(VENV_DIR)/bin/activate && pip install --editable . 
+
+# Install the package in normal mode for usage 
+install: 
+	@source $(VENV_DIR)/bin/activate && pip install . 
+
+
+
+
+# ╔══════════════════════════════════════════════════════════╗
+# ║ Build source distribution and wheel using pyproject.toml ║
+# ╚══════════════════════════════════════════════════════════╝
+
+
+
+build:
+	@source $(VENV_DIR)/bin/activate && python -m build --sdist --wheel
+	@echo "Source distribution and wheel built."
+	@echo "Build completed."
+
+build-check: 
+	@source $(VENV_DIR)/bin/activate && python -m twine check dist/*
+	@echo "Source distribution with twine check."
+	@echo "Build check completed."
+
+
+
+build-clean: 
+	@rm -rf dist/* 
+	@echo "Cleaned up the dist directory."
+
+
+
+# ╔═══════════════════╗
+# ║ Upload Functions  ║
+# ╚═══════════════════╝
+
+
+
+upload:
+	@echo "To upload, it will need to authenticate the credentials"
+	@source $(VENV_DIR)/bin/activate  && twine upload dist/*
+
+upload-test:
+	@echo "To upload, it will need to authenticate the credentials"
+	@source $(VENV_DIR)/bin/activate  && twine upload -r testpypi --verbose dist/fileagent-$(VERSION)* 
+	@echo "Uploaded to Test PyPI."
+
+
+
+
+# ╔════════════════════╗
+# ║ Testing Functions  ║
+# ╚════════════════════╝
+
+
+test:
+	@source $(VENV_DIR)/bin/activate && pytest -v --tb=short --disable-warnings --maxfail=1
+	@echo "Tests completed."
+
+
+
+
+
+# ╔═════════════════╗
+# ║ Documentations  ║
+# ╚═════════════════╝
+
+# Documentation using pdoc
+# pdoc is a documentation generator for Python projects
+# Directory for the pdoc documentation
+PDOC_DIR=docs/pdoc/
+
+# Function to ctreate the pdoc directory 
+$(PDOC_DIR):
+	@mkdir -p $(PDOC_DIR)
+	@echo "Created documentation directory $(PDOC_DIR)"
+
+SPHINX_DIR=docs/sphinx/
+
+# Function to create the documentation using pdoc
+# Leverages the makefile inside docs/
+doc-pdoc: $(PDOC_DIR)
+	@echo "Generating documentation using pdoc..."
+	@source $(VENV_DIR)/bin/activate && make -C $(PDOC_DIR) create
+	@echo "Documentation created using pdoc."
+
+# Function to host the documentation html created by pdoc, using pdoc
+# Leverages the makefile inside docs/
+doc-pdoc-host:
+	@echo "Documentation created and hosted by using pdoc."
+	@source $(VENV_DIR)/bin/activate && make -C $(PDOC_DIR) host
+
+
+doc-sphinx: $(SPHINX_DIR)
+	@echo "Generating documentation using Sphinx..."
+	@source $(VENV_DIR)/bin/activate && make -C $(SPHINX_DIR) html
+	@echo "Documentation created using Sphinx."
+
+doc-sphinx-host:
+	@echo "Hosting documentation using Sphinx..."
+	@source $(VENV_DIR)/bin/activate && cd $(SPHINX_DIR)/build/html && python -m http.server 8500 
+	@echo "Documentation hosted using Sphinx."
+
+
+# ╔════════════════╗
+# ║ Help Function  ║
+# ╚════════════════╝
+
+
+help:
+	@echo "Makefile for managing Python package setup, testing, and documentation."
+	@echo ""
+	@echo "Targets:"
+	@echo "  create-venv          Create a virtual environment."
+	@echo "  clean-venv           Remove the virtual environment."
+	@echo "  venv-upgrade-pip     Upgrade pip in the virtual environment."
+	@echo "  install-dev     Install the package in editable mode."
+	@echo "  install-pack-dev     Install the package in editable mode (alias)."
+	@echo "  install-req-dev      Install development dependencies."
+	@echo "  install-req-docs     Install documentation dependencies."
+	@echo "  install-req-all      Install all dependencies (dev and docs)."
+	@echo "  setup-all-dev        Create venv, upgrade pip, and install all dependencies."
+	@echo "  build                Build source distribution and wheel using pyproject.toml."
+	@echo "  build-check          Check the build with twine."
+	@echo "  upload               Upload to PyPI using twine."
+	@echo "  upload-test          Upload to Test PyPI using twine."
+	@echo "  test                 Run tests using pytest."
+	@echo "  doc-pdoc             Generate documentation using pdoc."
+	@echo "  doc-pdoc-host        Host documentation using pdoc."
+	@echo "  help                 Show this help message."
+	@echo ""
+	@echo "Note: Use 'source $(VENV_DIR)/bin/activate' to activate the virtual environment."
+	@echo "      Use 'deactivate' to exit the virtual environment."
+	@echo ""
+
+.PHONY: create-venv clean-venv venv-upgrade-pip setup-old setup-toml install-pack-dev install-req-dev install-req-docs setup-all-dev upload-pypi doc-pdoc doc-pdoc-host help
+

VERSION

@@ -1 +1 @@
-0.0.8
+0.0.12

app/CTFSolverScript.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: CTFSolverScript
+Version: 0.0.11
+Summary: An all in one library for solving CTF challenges
+Home-page: https://github.com/nikolasfil/CTFSolverScript
+Author: Nikolas Filippatos
+License: MIT
+Project-URL: Homepage, https://github.com/nikolasfil/CTFSolverScript
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: build>=0.7.0
+Requires-Dist: pwntools>=4.0.0
+Requires-Dist: scapy>=2.0.0
+Requires-Dist: argcomplete>=2.0.0
+Requires-Dist: setuptools>=67.7.0
+Requires-Dist: wheel>=0.37.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.2.4; extra == "dev"
+Requires-Dist: twine>=3.4.2; extra == "dev"
+Requires-Dist: pipdeptree>=2.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: pdoc3>=0.11.4; extra == "docs"
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# CTFSolverScript
+
+CTFSolverScript is a tool designed to assist in solving Capture The Flag (CTF) challenges. It provides utilities and scripts to streamline the process of solving various types of CTF problems.
+
+## Features
+
+- **Automated Scripts**: Pre-built scripts for common CTF tasks.
+- **Modular Design**: Easily extendable to add custom scripts.
+- **Cross-Platform**: Works on Linux, macOS, and Windows.
+- **Lightweight**: Minimal dependencies for quick setup.
+
+## Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/YourUsername/CTFSolverScript.git
+   cd CTFSolverScript
+   ```
+
+2. Use the Makefile to install dependencies:
+
+   ```bash
+   make install
+   ```
+
+## Usage
+
+1. Navigate to the project directory:
+
+   ```bash
+   cd CTFSolverScript
+   ```
+
+2. Run the main script:
+
+   ```bash
+   python solver.py
+   ```
+
+3. Follow the prompts to select the type of challenge you want to solve.
+
+## Directory Structure
+
+```
+CTFSolverScript/
+├── solver.py          # Main script
+├── modules/           # Custom modules for solving challenges
+├── examples/          # Example challenges and solutions
+├── requirements.txt   # Python dependencies
+├── Makefile           # Build and installation commands
+└── README.md          # Project documentation
+```
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Submit a pull request with a detailed description of your changes.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+For questions or suggestions, feel free to open an issue or contact the maintainer at `your.email@example.com`.

app/CTFSolverScript.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+app/CTFSolverScript.egg-info/PKG-INFO
+app/CTFSolverScript.egg-info/SOURCES.txt
+app/CTFSolverScript.egg-info/dependency_links.txt
+app/CTFSolverScript.egg-info/entry_points.txt
+app/CTFSolverScript.egg-info/requires.txt
+app/CTFSolverScript.egg-info/top_level.txt
+app/ctfsolver/__init__.py

app/CTFSolverScript.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

app/CTFSolverScript.egg-info/entry_points.txt

@@ -0,0 +1,7 @@
+[console_scripts]
+clean_folders = ctfsolver.scripts.run_clean_folders:main
+ctfsolver = ctfsolver.inline.__main__:main
+find_usage = ctfsolver.scripts.run_find_usage:main
+folders = ctfsolver.scripts.run_folders:main
+run = ctfsolver.scripts.run_solution:main
+templ = ctfsolver.scripts.__main__:run_template

app/CTFSolverScript.egg-info/requires.txt

@@ -0,0 +1,14 @@
+build>=0.7.0
+pwntools>=4.0.0
+scapy>=2.0.0
+argcomplete>=2.0.0
+setuptools>=67.7.0
+wheel>=0.37.0
+
+[dev]
+pytest>=6.2.4
+twine>=3.4.2
+pipdeptree>=2.0.0
+
+[docs]
+pdoc3>=0.11.4

app/CTFSolverScript.egg-info/top_level.txt

@@ -0,0 +1 @@
+ctfsolver