initial renaming to plate-simulation

MiraGeoscience · Jan 31, 2024 · 26809bb · 26809bb
1 parent 2527b9e
commit 26809bb
Show file tree

Hide file tree

Showing 27 changed files with 70 additions and 70 deletions.
diff --git a/.github/workflows/issue_to_jira.yml b/.github/workflows/issue_to_jira.yml
@@ -26,7 +26,7 @@ jobs:
         summary: ${{ github.event.issue.title }}
         description: "_from [GitHub issue #${{ github.event.issue.number }}|${{ github.event.issue.html_url }}]_"
         # Additional fields in JSON format
-        #fields: '{"components": [{"name": "my-app"}]}'
+        #fields: '{"components": [{"name": "plate-simulation"}]}'
     - name: Post JIRA link
       uses: peter-evans/create-or-update-comment@v3
       with:

diff --git a/.github/workflows/pytest-unix-os.yml b/.github/workflows/pytest-unix-os.yml
@@ -21,7 +21,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  source_dir: my_app
+  source_dir: plate_simulation
 
 jobs:
   pytest:

diff --git a/.github/workflows/pytest-windows.yml b/.github/workflows/pytest-windows.yml
@@ -21,7 +21,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  source_dir: my_app
+  source_dir: plate_simulation
 
 jobs:
   pytest:

diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -21,7 +21,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  source_dir: my_app
+  source_dir: plate_simulation
 
 jobs:
   pre-commit:

diff --git a/.idea/copyright/MiraGeoscience.xml b/.idea/copyright/MiraGeoscience.xml
diff --git a/.idea/scopes/sources.xml b/.idea/scopes/sources.xml
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,7 +1,7 @@
 
 default_language_version:
     python: python3
-exclude: (^docs/(conf.py|_ext/)|^my_app-assets/)
+exclude: (^docs/(conf.py|_ext/)|^plate_simulation-assets/)
 default_stages: [commit,push]
 fail_fast: false
 

diff --git a/Install_or_Update.bat b/Install_or_Update.bat
@@ -9,7 +9,7 @@ if !errorlevel! neq 0 (
 
 set PY_VER=3.10
 
-set ENV_NAME=my_app
+set ENV_NAME=plate_simulation
 set MY_CONDA=!MY_CONDA_EXE:"=!
 cd %~dp0
 set PYTHONUTF8=1

diff --git a/README-dev.rst b/README-dev.rst
@@ -56,7 +56,7 @@ Install the Conda environment
 
 For development, you need a **Conda** environments. you can install it running the ``setup-dev.bat`` or::
 
-    $ [path\to\my-app]\devtools\setup-dev.bat
+    $ [path\to\plate-simulation]\devtools\setup-dev.bat
 
 This command install a local environment at the base of your repository: ``.conda-env``.
 This environment should automatically be recognized by the Conda installation.
@@ -287,7 +287,7 @@ and select the desired environment from the list (the one in the ``.conda-env``
         :width: 80%
 
 Then you can check the list of installed packages in the ``Packages`` table. You should see
-**my-app** and its dependencies. Make sure to turn off the ``Use Conda Package Manager``
+**plate-simulation** and its dependencies. Make sure to turn off the ``Use Conda Package Manager``
 option to see also the packages installed through pip:
 
     ..  image:: devtools/images/pycharm-list_all_conda_packages.png

diff --git a/README.rst b/README.rst
@@ -1,60 +1,60 @@
 |coverage| |maintainability| |precommit_ci| |docs| |style| |version| |status| |pyversions|
 
 
-.. |docs| image:: https://readthedocs.org/projects/my-app/badge/
+.. |docs| image:: https://readthedocs.org/projects/plate-simulation/badge/
     :alt: Documentation Status
-    :target: https://my-app.readthedocs.io/en/latest/?badge=latest
+    :target: https://plate-simulation.readthedocs.io/en/latest/?badge=latest
 
-.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/my-app/branch/develop/graph/badge.svg
+.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/plate-simulation/branch/develop/graph/badge.svg
     :alt: Code coverage
-    :target: https://codecov.io/gh/MiraGeoscience/my-app
+    :target: https://codecov.io/gh/MiraGeoscience/plate-simulation
 
 .. |style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :alt: Coding style
     :target: https://github.com/pf/black
 
-.. |version| image:: https://img.shields.io/pypi/v/my-app.svg
+.. |version| image:: https://img.shields.io/pypi/v/plate-simulation.svg
     :alt: version on PyPI
-    :target: https://pypi.python.org/pypi/my-app/
+    :target: https://pypi.python.org/pypi/plate-simulation/
 
-.. |status| image:: https://img.shields.io/pypi/status/my-app.svg
+.. |status| image:: https://img.shields.io/pypi/status/plate-simulation.svg
     :alt: version status on PyPI
-    :target: https://pypi.python.org/pypi/my-app/
+    :target: https://pypi.python.org/pypi/plate-simulation/
 
-.. |pyversions| image:: https://img.shields.io/pypi/pyversions/my-app.svg
+.. |pyversions| image:: https://img.shields.io/pypi/pyversions/plate-simulation.svg
     :alt: Python versions
-    :target: https://pypi.python.org/pypi/my-app/
+    :target: https://pypi.python.org/pypi/plate-simulation/
 
-.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/my-app/develop.svg
+.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/plate-simulation/develop.svg
     :alt: pre-commit.ci status
-    :target: https://results.pre-commit.ci/latest/github/MiraGeoscience/my-app/develop
+    :target: https://results.pre-commit.ci/latest/github/MiraGeoscience/plate-simulation/develop
 
 .. |maintainability| image:: https://api.codeclimate.com/v1/badges/_token_/maintainability
-   :target: https://codeclimate.com/github/MiraGeoscience/my-app/maintainability
+   :target: https://codeclimate.com/github/MiraGeoscience/plate-simulation/maintainability
    :alt: Maintainability
 
 
-my-app: # TODO: SHORT DESCRIPTION
+plate-simulation: # TODO: SHORT DESCRIPTION
 =========================================================================
-The **my-app** library # TODO: PACKAGE DESCRIPTION
+The **plate-simulation** library # TODO: PACKAGE DESCRIPTION
 
 .. contents:: Table of Contents
    :local:
    :depth: 3
 
 Documentation
 ^^^^^^^^^^^^^
-`Online documentation <https://my-app.readthedocs.io/en/latest/>`_
+`Online documentation <https://plate-simulation.readthedocs.io/en/latest/>`_
 
 
 Installation
 ^^^^^^^^^^^^
-**my-app** is currently written for Python 3.10 or higher.
+**plate-simulation** is currently written for Python 3.10 or higher.
 
 Install Conda
 -------------
 
-To install **my-app**, you need to install **Conda** first.
+To install **plate-simulation**, you need to install **Conda** first.
 
 We recommend to install **Conda** using `miniforge`_.
 
@@ -63,7 +63,7 @@ We recommend to install **Conda** using `miniforge`_.
 Within a conda environment
 --------------------------
 
-You can install (or update) a conda environment with all the requires packages to run **my-app**.
+You can install (or update) a conda environment with all the requires packages to run **plate-simulation**.
 To do so you can directly run the **Install_or_Update.bat** file by double left clicking on it.
 
 Install with conda
@@ -84,25 +84,25 @@ Still, you can install it in a conda environment without its dependencies (``--n
 From PyPI
 ~~~~~~~~~
 
-To install the **my-app** package published on PyPI:
+To install the **plate-simulation** package published on PyPI:
 
 .. code-block:: bash
 
-    pip install -U --no-deps my-app
+    pip install -U --no-deps plate-simulation
 
 From a Git tag or branch
 ~~~~~~~~~~~~~~~~~~~~~~~~
 If the package is not on PiPY yet, you can install it from a Git tag:
 
 .. code-block:: bash
 
-    pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/my-app/archive/refs/tags/TAG.zip
+    pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/plate-simulation/archive/refs/tags/TAG.zip
 
 Or to install the latest changes available on a given Git branch:
 
 .. code-block:: bash
 
-    pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/my-app/archive/refs/heads/BRANCH.zip
+    pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/plate-simulation/archive/refs/heads/BRANCH.zip
 
 .. note::
     The ``--force-reinstall`` option is used to make sure the updated version
@@ -113,7 +113,7 @@ Or to install the latest changes available on a given Git branch:
 From a local copy of the sources
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 If you have a git clone of the package sources locally,
-you can install **my-app** from the local copy of the sources with:
+you can install **plate-simulation** from the local copy of the sources with:
 
 .. code-block:: bash
 
@@ -137,7 +137,7 @@ License
 
 Third Party Software
 ^^^^^^^^^^^^^^^^^^^^
-The my-app Software may provide links to third party libraries or code (collectively “Third Party Software”)
+The plate-simulation Software may provide links to third party libraries or code (collectively “Third Party Software”)
 to implement various functions. Third Party Software does not comprise part of the Software.
 The use of Third Party Software is governed by the terms of such software license(s).
 Third Party Software notices and/or additional terms and conditions are located in the

diff --git a/THIRD_PARTY_SOFTWARE.rst b/THIRD_PARTY_SOFTWARE.rst
@@ -1,4 +1,4 @@
-The my-app repository and source distributions bundle several libraries that are
+The plate-simulation repository and source distributions bundle several libraries that are
 compatibly licensed.  We list these here.
 
 # TODO

diff --git a/devtools/add_url_tag_sha256.py b/devtools/add_url_tag_sha256.py
@@ -2,7 +2,7 @@
 
 #  Copyright (c) 2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 

diff --git a/devtools/check-copyright.py b/devtools/check-copyright.py
@@ -2,7 +2,7 @@
 
 #  Copyright (c) 2022-2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 

diff --git a/devtools/git_message_hook.py b/devtools/git_message_hook.py
@@ -2,7 +2,7 @@
 
 #  Copyright (c) 2022-2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 

diff --git a/devtools/run_conda_lock.py b/devtools/run_conda_lock.py
@@ -2,7 +2,7 @@
 
 #  Copyright (c) 2022-2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 

diff --git a/devtools/start-app.bat b/devtools/start-app.bat
@@ -9,7 +9,7 @@ if !errorlevel! neq 0 (
 )
 
 set env_path=%project_dir%\.conda-env
-cd %project_dir%\my_app
+cd %project_dir%\plate_simulation
 set "PYTHONPATH=%project_dir%;%PYTHONPATH%"
 call !MY_CONDA_EXE! run -n %env_path% jupyter notebook Index.ipynb
 cmd /k
diff --git a/my_app-assets/uijson/hello.ui.json b/my_app-assets/uijson/hello.ui.json
diff --git a/my_app-assets/__init__.py → plate_simulation-assets/__init__.py b/my_app-assets/__init__.py → plate_simulation-assets/__init__.py
@@ -1,5 +1,5 @@
 #  Copyright (c) 2024 Mira Geoscience Ltd.
 #
-#  This file is part of my_app package.
+#  This file is part of plate_simulation package.
 #
 #  All rights reserved.
diff --git a/plate_simulation-assets/uijson/hello.ui.json b/plate_simulation-assets/uijson/hello.ui.json
@@ -0,0 +1,10 @@
+{"title": "plate-simulation Hello World",
+ "run_command": "plate_simulation.commands.hello",
+  "conda_environment": "plate_simulation",
+  "name": {
+    "main": true,
+    "label": "Name",
+    "value": "World",
+    "tooltip": "Name to say hello to"
+  }
+}
diff --git a/my_app/__init__.py → plate_simulation/__init__.py b/my_app/__init__.py → plate_simulation/__init__.py
@@ -1,6 +1,6 @@
 #  Copyright (c) 2022-2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 

diff --git a/my_app/commands/__init__.py → plate_simulation/commands/__init__.py b/my_app/commands/__init__.py → plate_simulation/commands/__init__.py
@@ -1,5 +1,5 @@
 #  Copyright (c) 2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
diff --git a/my_app/commands/hello_world.py → plate_simulation/commands/hello_world.py b/my_app/commands/hello_world.py → plate_simulation/commands/hello_world.py
@@ -1,6 +1,6 @@
 #  Copyright (c) 2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 

diff --git a/my_app/main.py → plate_simulation/main.py b/my_app/main.py → plate_simulation/main.py
@@ -1,6 +1,6 @@
 #  Copyright (c) 2022-2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,15 +1,15 @@
 [tool.poetry]
-name = "my-app"
+name = "plate-simulation"
 version = "0.1.0-alpha.1"
 license = ""  # TODO: pick a license type
 description = "My application"
 authors = ["Mira Geoscience <[email protected]>"]
-repository = "https://github.com/MiraGeoscience/my-app"
+repository = "https://github.com/MiraGeoscience/plate-simulation"
 homepage = "https://mirageoscience.com"
 readme = "README.rst"
 packages = [
-     { include = "my_app" },
-     { include = "my_app-assets" },
+     { include = "plate_simulation" },
+     { include = "plate_simulation-assets" },
 ]
 
 # TODO: adjust classifiers
@@ -28,7 +28,7 @@ classifiers = [
 ]
 
 [tool.poetry.scripts]
-my_app_hello = 'my_app.commands.hello'
+my_app_hello = 'plate_simulation.commands.hello'
 
 [tool.poetry.dependencies]
 python = "^3.9, <3.11"
@@ -92,9 +92,9 @@ plugins = [
 
 [tool.coverage.run]
 branch = true
-source = ["my_app"]
+source = ["plate_simulation"]
 omit = [
-    "my_app/commands/hello_world.py"
+    "plate_simulation/commands/hello_world.py"
 ]
 
 [tool.coverage.report]

diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,5 +1,5 @@
 #  Copyright (c) 2022-2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
diff --git a/tests/assets_path_test.py b/tests/assets_path_test.py
@@ -1,11 +1,11 @@
 #  Copyright (c) 2024 Mira Geoscience Ltd.
 #
-#  This file is part of my-app package.
+#  This file is part of plate-simulation package.
 #
 #  All rights reserved.
 #
 
-from my_app import assets_path
+from plate_simulation import assets_path
 
 
 def test_assets_directory_exist():
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ concurrency: @@
       cancel-in-progress: true
     env:
-      source_dir: my_app
+      source_dir: plate_simulation
     jobs:
       pytest:
@@ Expand Down @@