Merge pull request #6 from mattdeform/make-versions-branch-based

removed multiple builds in plugin source in favor of branches

Author: mattdeform

.github/workflows/reusable-static-analysis.yml

@@ -26,17 +26,19 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint mypy
+        pip install pip-tools
+        pip-compile --output-file requirements.txt requirements.in requirements-dev.in requirements-test.in
+        pip-sync requirements.txt
 
     - name: Analysing the code with pylint
       run: |
-        pylint plugin_src/5.4.0/pycharm_remote_debug/Content/Python
+        pylint plugin_src/PyCharmRemoteDebug/Content/Python/  
 
     - name: Analysing the code with black
       uses: psf/black@stable
       with:
-        src: "plugin_src/5.4.0/pycharm_remote_debug/Content/Python"
+        src: "plugin_src/PyCharmRemoteDebug/Content/Python/"
         options: "--diff"
 
     - name: Analysing the code with mypy
-      run: mypy plugin_src/5.4.0/pycharm_remote_debug/Content/Python
+      run: mypy plugin_src/PyCharmRemoteDebug/Content/Python/

CONTRIBUTING.md

@@ -89,7 +89,7 @@ To run tests locally:
 
 with coverage:
 -   ```sh
-    pytest --cov=plugin_src/5.4.0/pycharm_remote_debug/Content/Python
+    pytest --cov=plugin_src/PyCharmRemoteDebug/Content/Python
     ```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -101,20 +101,20 @@ Static code analysis is performed with [Pylint](https://pypi.org/project/pylint/
 To run pylint locally:
 
 -   ```sh
-    pylint --rcfile=.pylintrc plugin_src/5.4.0/pycharm_remote_debug/
+    pylint --rcfile=.pylintrc plugin_src/PyCharmRemoteDebug/Content/Python/
     ```
     - A modified [.pylintrc](.pylintrc) file is provided with modifications to ignore Unreal import errors. Append to this file as needed.  
 
 Black formater can be run locally with:
 
 -   ```sh
-    black plugin_src/5.4.0/pycharm_remote_debug/
+    black plugin_src/PyCharmRemoteDebug/Content/Python/
     ```
 
 Run [mypy](https://mypy.readthedocs.io/en/stable/) checks locally with:
 
 -   ```sh
-    mypy plugin_src/5.4.0/pycharm_remote_debug/
+    mypy plugin_src/PyCharmRemoteDebug/Content/Python/
     ```
     - A modified [mypy.ini](mypy.ini) file is included with modifications to ignore Unreal import errors. Append to this file as needed.
 

README.md

@@ -50,7 +50,6 @@
     </li>
     <li><a href="#roadmap">Roadmap</a></li>
     <li><a href="#contributing">Contributing</a></li>
-    <li><a href="#license">License</a></li>
     <li><a href="#contact">Contact</a></li>
     <li><a href="#acknowledgments">Acknowledgments</a></li>
   </ol>
@@ -59,7 +58,7 @@
 
 <!-- ABOUT THE PROJECT -->
 ## About The Project
-<b>This is NOT an official JetBrains or Epic Games plugin, just a small utility I built for myself that I figured others might find useful.</b>
+> <b>This is <u>NOT</u> an official JetBrains or Epic Games plugin.</b>
 
 <div align="center">
 
@@ -75,7 +74,7 @@
 
 ### Prerequisites
 
-* [Unreal 5.4.0](https://www.unrealengine.com)
+* [Unreal Engine 5](https://www.unrealengine.com)
 * [PyCharm Professional](https://www.jetbrains.com/pycharm/buy/)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -129,14 +128,6 @@ If you have a suggestion that would make this better, please open an issue from
 
 Development and contribution guidelines can be found on the [CONTRIBUTING.md](CONTRIBUTING.md) page
 
-<!-- LICENSE -->
-## License
-
-Distributed under the `insert_license_name` license. See `LICENSE` file for more information.
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-
 
 <!-- CONTACT -->
 ## Contact
@@ -165,10 +156,5 @@ Please reach out via the [request a feature](https://github.com/mattdeform/unrea
 [python-url]: https://python.org/
 [pytest-shield]: https://img.shields.io/badge/tests-pytest-%230A9EDC
 [pytest-url]: https://docs.pytest.org/
-[github-shield]: https://img.shields.io/badge/GitHub-%23181717?logo=github
-[github-url]: https://github.com/
-[github-actions-shield]: https://img.shields.io/badge/GitHub%20Actions-%232671E5?logo=githubactions&logoColor=white
-[github-actions-url]: https://github.com/features/actions
-
 [unreal_5-shield]: https://img.shields.io/badge/Unreal%20Engine-5.x-grey?logo=unrealengine&labelColor=%230E1128
 [unreal-url]: https://www.unrealengine.com/en-US

mkdocs.yml

@@ -0,0 +1,2 @@
+[FilterPlugin]
+/Config/tool_config.json

plugin_src/5.4.0/pycharm_remote_debug/Config/FilterPlugin.ini

@@ -1,7 +1,7 @@
 """ Plugin initialization script """
 
 try:
-    from pycharmremotedebug.menu import install
+    from pycharmremotedebug.menu import install  # type: ignore
 
     install()
 except ImportError: