diff --git a/.github/ISSUE_TEMPLATE/ask_a_question.md b/.github/ISSUE_TEMPLATE/ask_a_question.md new file mode 100644 index 0000000..9e93c30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask_a_question.md @@ -0,0 +1,12 @@ +--- +name: Ask a Question +about: Ask a question about using dot +labels: question + +--- + +## :question: Ask a Question: + +### Description: + + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f08d4b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug Report +about: Report bugs to improve dot +labels: bug + +--- + +## :bug: Bug Report + + + +### Description: + +#### Actual Behavior: + + + +#### Expected Behavior: + + diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..3619cfe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,14 @@ +--- +name: Documentation +about: Report an issue related to dot documentation +labels: documentation + +--- + +## :memo: Documentation + + + +### Description: + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d28c793 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature Request +about: Submit a feature request for dot +labels: feature + +--- + +## :sparkles: Feature Request + + + +### Description: + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..9e068f9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + +## Description + + + + + +Fixes #(issue-number) + +### Changelog: + + + +#### Added: + +- ... + +#### Updated: + +- ... + +#### Fixed: + +- ... + +#### Removed: + +- ... diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b9f1a5b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,31 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- ... + +### Updated + +- ... + +### Fixed + +- ... + +### Removed + +- ... + +## [1.0.0] - 2022-06-04 + +- dot is open sourced + +[Unreleased]: https://github.com/sensity-ai/dot/compare/1.0.0...HEAD +[1.0.0]: https://github.com/sensity-ai/dot/releases/tag/1.0.0 diff --git a/README.md b/README.md index fb96ffe..fc48987 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -# Deepfake Offensive Toolkit +
-[![build-dot](https://github.com/sensity-ai/dot/actions/workflows/build_dot.yaml/badge.svg)](https://github.com/sensity-ai/dot/actions/workflows/build_dot.yaml) [![code-check](https://github.com/sensity-ai/dot/actions/workflows/code_check.yaml/badge.svg)](https://github.com/sensity-ai/dot/actions/workflows/code_check.yaml) +

Deepfake Offensive Toolkit

+ +[![stars](https://img.shields.io/github/stars/sensity-ai/dot)](https://github.com/sensity-ai/dot/stargazers) +[![license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://github.com/sensity-ai/dot/blob/main/LICENSE) +[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-3712/) +[![build-dot](https://github.com/sensity-ai/dot/actions/workflows/build_dot.yaml/badge.svg)](https://github.com/sensity-ai/dot/actions/workflows/build_dot.yaml) +[![code-check](https://github.com/sensity-ai/dot/actions/workflows/code_check.yaml/badge.svg)](https://github.com/sensity-ai/dot/actions/workflows/code_check.yaml) + +
*dot* (aka Deepfake Offensive Toolkit) makes real-time, controllable deepfakes ready for virtual cameras injection. *dot* is created for performing penetration testing against e.g. identity verification and video conferencing systems, for the use by security analysts, Red Team members, and biometrics researchers. @@ -267,6 +275,10 @@ If you have ideas for improving *dot*, feel free to open relevant Issues and PRs If you are working on improving the speed of *dot*, please read first our guide on [code profiling](docs/profiling.md). +### Changelog + +Visit [CHANGELOG.md](./CHANGELOG.md) to track changes in the repository. + ### Setup Dev-Tools 1. Install Dev Requirements diff --git a/dot/__init__.py b/dot/__init__.py index ac233b5..1ca9ec8 100644 --- a/dot/__init__.py +++ b/dot/__init__.py @@ -6,7 +6,7 @@ from .dot import DOT -__version__ = "2.0.0" +__version__ = "1.0.0" __author__ = "Sensity" __url__ = "https://github.com/sensity-ai/dot/tree/main/dot" __docs__ = "Deepfake offensive toolkit"