pyattackforge 0.1.0__py3-none-any.whl → 0.1.3__py3-none-any.whl

pyattackforge-0.1.0.dist-info/METADATA

@@ -1,120 +0,0 @@
-Metadata-Version: 2.4
-Name: pyattackforge
-Version: 0.1.0
-Summary: Python wrapper for the AttackForge API
-Home-page: https://github.com/Tantalum-Labs/PyAttackForge
-Author: Shane S
-License: AGPL-3.0
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.20.0
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# PyAttackForge
-
-A lightweight Python library for interacting with the AttackForge API.
-
----
-
-## Features
-
-- Create and fetch projects
-- Manage assets
-- Submit vulnerabilities
-- Dry-run mode for testing
-
----
-
-## Install
-
-   ```bash
-   mkdir PyAttackForgeEnv
-   cd PyAttackForgeEnv
-   virtualenv venv
-   source ./venv/bin/activate
-   pip install git+https://github.com/Tantalum-Labs/PyAttackForge.git
-   ```
-
-## Use
-
-   ```python
-   from pyattackforge import PyAttackForgeClient
-
-   # Initialize client - Note: Make sure to set your AttackForge URL and API Key
-   client = PyAttackForgeClient(api_key="your-api-key", base_url="https://demo.attackforge.com", dry_run=False)
-
-   # Create a project
-   project = client.create_project("My Project", scope=["Asset1", "Asset2"])
-
-   ## Create a vulnerability with auto-created assets
-   client.create_vulnerability(
-       vulnerability_data={
-           "projectId": "abc123",
-           "title": "Open SSH Port",
-           "affected_assets": [{"assetName": "ssh-prod-1"}],
-           "priority": "High",
-           "likelihood_of_exploitation": 10,
-       },
-       auto_create_assets=True,
-       default_asset_type="Cloud",
-       default_asset_library_ids=["your-lib-id"]
-   )
-
-   ```
-
----
-
-## API Reference
-
-### `PyAttackForgeClient`
-
-- `__init__(api_key: str, base_url: str = ..., dry_run: bool = False)`
-- `get_assets() -> dict`
-- `get_asset_by_name(name: str) -> dict or None`
-- `create_asset(asset_data: dict) -> dict`
-- `get_project_by_name(name: str) -> dict or None`
-- `get_project_scope(project_id: str) -> set`
-- `update_project_scope(project_id: str, new_assets: list) -> dict`
-- `create_project(name: str, **kwargs) -> dict`
-- `update_project(project_id: str, update_fields: dict) -> dict`
-- `create_vulnerability(vulnerability_data: dict, auto_create_assets: bool = False, ...) -> dict`
-
-See the source code for full details and docstrings.
-
----
-
-## Contributing
-
-Contributions are welcome! Please open issues or submit pull requests via GitHub.
-
-- Ensure code is PEP8-compliant and includes docstrings and type hints.
-- Add or update tests for new features or bugfixes.
-- Do **not** commit API keys or other secrets.
-
----
-
-## Security
-
-**Never commit your API keys or other sensitive information to version control.**
-
----
-
-## License
-
-This project is licensed under the [GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.html).

pyattackforge-0.1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-pyattackforge/__init__.py,sha256=xZxubdjv_Fc1bRqfVRMR4j9SCTLXg9TfckWn9CQHH_E,839
-pyattackforge/client.py,sha256=wYyWCscQGYlysBgvxhnQlZnEdhTT8555RmSJ8FH9lrw,12784
-pyattackforge-0.1.0.dist-info/licenses/LICENSE,sha256=bx5iLIKjgAdYQ7sISn7DsfHRKkoCUm1154sJJKhgqnU,35184
-pyattackforge-0.1.0.dist-info/METADATA,sha256=Xm1YpRAVkEKp5KeQqS2JM5zvfrCYEX90qmfNI9B6FtA,3311
-pyattackforge-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyattackforge-0.1.0.dist-info/top_level.txt,sha256=1rDeMkWvFWuX3MS8V65no7KuybYyvtfIgbYSt5m_uPU,14
-pyattackforge-0.1.0.dist-info/RECORD,,