Dot executable (#92)

* Update config path * Add windows 10 executable * pyinstaller in reqs * Update link * Create docs for generating executable * Update CHANGELOG.md * Update CHANGELOG.md * Add steps to generate the executable
sensity-ai · Jul 20, 2023 · 94f3938 · 94f3938
1 parent 70eff88
commit 94f3938
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,12 +5,17 @@ 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]
+## [1.2.0] - 2023-07-20
 
+## What's Changed
+* Create a dot executable for windows by @Ghassen-Chaabouni in https://github.com/sensity-ai/dot/pull/92
+* Add a graphical interface for dot by @Ghassen-Chaabouni in https://github.com/sensity-ai/dot/pull/85
 * Update README and CONTRIBUTING by @giorgiop in https://github.com/sensity-ai/dot/pull/40
 * Fix config paths in additional scripts under `scripts/` folder by @Ghassen-Chaabouni in https://github.com/sensity-ai/dot/pull/43
 * Update README and add instructions for running dot with an Android emulator by @Ghassen-Chaabouni in https://github.com/sensity-ai/dot/pull/45
 
+**Full Changelog**: https://github.com/sensity-ai/dot/compare/1.1.0...1.2.0
+
 ## [1.1.0] - 2022-07-27
 
 ## What's Changed
@@ -31,7 +36,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Speed up SimSwap's `reverse2original` by @ajndkr and @Ghassen-Chaabouni in https://github.com/sensity-ai/dot/pull/20
 * Add `bumpversion` for semantic versioning by @ajndkr in https://github.com/sensity-ai/dot/pull/34
 * Update README with speed metrics by @giorgiop in https://github.com/sensity-ai/dot/pull/37
-* Add a Graphical interface for dot by @Ghassen-Chaabouni in https://github.com/sensity-ai/dot/pull/85
 
 ## New Contributors
 * @giorgiop made their first contribution in https://github.com/sensity-ai/dot/pull/6
@@ -49,6 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 **Full Changelog**: https://github.com/sensity-ai/dot/commits/1.0.0
 
-[Unreleased]: https://github.com/sensity-ai/dot/compare/1.1.0...HEAD
+[Unreleased]: https://github.com/sensity-ai/dot/compare/1.2.0...HEAD
+[1.2.0]: https://github.com/sensity-ai/dot/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/sensity-ai/dot/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensity-ai/dot/releases/tag/1.0.0
diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@ Supported methods:
 Download and run the dot executable for your OS:
 
 - Windows:
-  - ToDo
+  - Download `dot.zip` from [here](https://drive.google.com/drive/folders/1gR5zIG2RHoMnsaXVzeBlM_Sk1tO4scJx?usp=drive_link), unzip it and then run `dot.exe`
 - Ubuntu:
   - ToDo
 - Mac:

diff --git a/docs/create_executable.md b/docs/create_executable.md
@@ -0,0 +1,36 @@
+# Create executable
+
+Create an executable of dot for different OS.
+
+## Windows
+
+Follow these steps to generate the executable for Windows.
+
+1. Run these commands
+
+```
+cd path/to/dot
+conda activate dot
+```
+
+2. Get the path of the `site-packages` by running this command
+
+```
+python -c "import site; print(''.join(site.getsitepackages()))"
+```
+
+3. Replace `path/to/site-packages` with the path of the `site-packages` and run this command
+
+```
+pyinstaller --noconfirm --onedir --name "dot" --add-data "src/dot/fomm/config;dot/fomm/config" --add-data "src/dot/simswap/models;dot/simswap/models" --add-data "path/to/site-packages;." --add-data "configs;configs/" --add-data "data;data/" --add-data "saved_models;saved_models/" src/dot/ui/ui.py
+```
+
+The executable files can be found under the folder `dist`.
+
+## Ubuntu
+
+ToDo
+
+## Mac
+
+ToDo
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -6,10 +6,10 @@
 #
 absl-py==1.1.0
     # via mediapipe
+altgraph==0.17.3
+    # via pyinstaller
 asttokens==2.0.5
     # via stack-data
-atomicwrites==1.4.1
-    # via pytest
 attrs==21.4.0
     # via
     #   mediapipe
@@ -26,18 +26,12 @@ certifi==2022.12.7
     # via requests
 cfgv==3.3.1
     # via pre-commit
-chardet==4.0.0
+charset-normalizer==3.2.0
     # via requests
 click==8.0.2
     # via
     #   black
     #   dot (setup.cfg)
-colorama==0.4.6
-    # via
-    #   click
-    #   ipython
-    #   pytest
-    #   tqdm
 coverage==6.4.2
     # via pytest-cov
 customtkinter==5.2.0
@@ -142,6 +136,8 @@ parso==0.8.3
     # via jedi
 pathspec==0.9.0
     # via black
+pexpect==4.8.0
+    # via ipython
 pickleshare==0.7.5
     # via ipython
 pillow==9.3.0
@@ -166,6 +162,8 @@ protobuf==3.20.2
     #   dot (setup.cfg)
     #   mediapipe
     #   onnxruntime
+ptyprocess==0.7.0
+    # via pexpect
 pure-eval==0.2.2
     # via stack-data
 py==1.11.0
@@ -176,6 +174,10 @@ pyflakes==2.3.1
     # via flake8
 pygments==2.15.0
     # via ipython
+pyinstaller==5.13.0
+    # via dot (setup.cfg)
+pyinstaller-hooks-contrib==2023.5
+    # via pyinstaller
 pyparsing==3.0.9
     # via
     #   matplotlib

diff --git a/requirements.txt b/requirements.txt
@@ -10,15 +10,10 @@ attrs==21.4.0
     # via mediapipe
 certifi==2022.12.7
     # via requests
-chardet==4.0.0
+charset-normalizer==3.2.0
     # via requests
 click==8.0.2
     # via dot (setup.cfg)
-colorama==0.4.6
-    # via
-    #   click
-    #   pytest
-    #   tqdm
 customtkinter==5.2.0
     # via dot (setup.cfg)
 cycler==0.11.0

diff --git a/setup.cfg b/setup.cfg
@@ -57,6 +57,7 @@ dev =
 	ipython
 	isort==5.12.0
 	pre-commit
+	pyinstaller
 	pytest
 	pytest-cov
 	types-PyYAML