You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: developer_README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,13 +14,13 @@ This template is designed according to a file structure that is necessary for yo
14
14
Here you find an overview of the files and their function in the SDK:
15
15
16
16
1.`./app/app.py`: must be modified by the developer. This is the entrypoint for your App logic. MoveApps will call this class during a Workflow execution which includes your App. The class must be named `App` and the file must be named `./app/app.py`, do not alter it. See [Step 4](https://docs.moveapps.org/#/create_py_app#step-4-develop-the-app-code-locally-within-the-template) in the User Manual.
17
-
1.`./appspec.json`: must be modified by the developer. This file defines the settings and metadata of your App. See [Step 6](https://docs.moveapps.org/#/create_py_app?id=step-6-write-app-specifications) in the User Manual.
18
-
1.`./environment.yml`: must be modified by the developer. Definition of the dependencies of your App. We use `conda` as library manager. See [Step 7](https://docs.moveapps.org/#/create_py_app?id=step-7-store-environment-dependencies) in the User Manual.
19
-
1.`./README.md`: must be modified by the developer. Provided template for the documentation of the App (see [Step 8](https://docs.moveapps.org/#/create_py_app?id=step-8-write-a-documentation-file) in the User Manual).
20
-
1.`./tests/**`: must be modified by the developer. Location for *Unit Tests*. See [Step 5](https://docs.moveapps.org/#/create_py_app#=step-5-test-your-app-locally) of the User Manual.
17
+
1.`./appspec.json`: must be modified by the developer. This file defines the settings and metadata of your App. See [Step 7](https://docs.moveapps.org/#/create_py_app?id=step-7-write-app-specifications) in the User Manual.
18
+
1.`./environment.yml`: must be modified by the developer. Definition of the dependencies of your App. We use `conda` as library manager. See [Step 8](https://docs.moveapps.org/#/create_py_app?id=step-8-store-environment-dependencies) in the User Manual.
19
+
1.`./README.md`: must be modified by the developer. Provided template for the documentation of the App (see [Step 9](https://docs.moveapps.org/#/create_py_app?id=step-9-write-a-documentation-file) in the User Manual).
20
+
1.`./tests/**`: must be modified by the developer. Location for *Unit Tests*. See [Step 6](https://docs.moveapps.org/#/create_py_app?id=step-6-unit-tests) of the User Manual.
21
21
1.`./sdk.py`: use for App testing. The main entrypoint of the SDK. Use it to execute your App in your compiler (e.g. PyCharm).
22
-
1.`./app-configuration.json`: adjust for App testing. The configuration/settings file of your App (in [JSON](https://www.w3schools.com/js/js_json_intro.asp) format - must correspondent with the `settings` of your `appspec.json`, see [MoveApps parameters](https://docs.moveapps.org/#/copilot-python-sdk.md#moveapps-parameters) for an example).
23
-
1.`.env`: adjust for App testing. defining the SDK Runtime environment, see below.
22
+
1.`./app-configuration.json`: adjust for App testing. The configuration/settings file of your App (in [JSON](https://www.w3schools.com/js/js_json_intro.asp) format - must correspondent with the `settings` of your `appspec.json`, see [MoveApps parameters](https://docs.moveapps.org/#/copilot-python-sdk.md#moveapps-parameters) for an example). See [Step 5](https://docs.moveapps.org/#/create_py_app?id=step-5-test-your-app-locally)
23
+
1.`.env`: adjust for App testing. defining the SDK Runtime environment, see below. See [Step 5](https://docs.moveapps.org/#/create_py_app?id=step-5-test-your-app-locally)
24
24
1.`./resources/**`: use for App testing. Resources of the SDK
25
25
1.`auxiliary/**`: Simulates the usage of [*auxiliary files*](https://docs.moveapps.org/#/auxiliary). You can put files into this folder to simulate an App run with provided/user-uploaded files.
26
26
1.`output/**`: The output data (`output.pickle`) that will be passed on to the next App in a Workflow and other output files (artifacts) that your App may produce will be stored here. See [*producing artifacts*](https://docs.moveapps.org/#/copilot-python-sdk?id=producing-artifacts) for more information.
0 commit comments