44 lines (29 loc) · 1.69 KB

Application Setup

Requirements

Install Python (version >= 3.9) and pip.
Install the required packages (pip install -r requirements.txt).

App Configuration

Create a configuration file, see the Sample Config for an example.

Running the API

In PyCharm

Select flask_app.py as the primary script.
Specify the above configuration file path as the first argument (parameter).
Set the following environment variables:PYTHONUNBUFFERED=1;FLASK_ENV=development

Running Tests

In PyCharm

Ensure the Source/Python directory is marked as a source root
Select the Test/Unittest directory to create the PyCharm Unittest run config
Modify the working directory parameter to point at the main project root.

Releasing a New Version

Update the version in the API Specification json
Update the API Specification link in the Read Me.
Update the version in python project.
Add a section for the new version to the Changelog.
Create a pull request to the main branch.
Create a release with the same version.
In addition to the source files generated by GitHub, create a Deployable zip file with the following project files:
- The Script, Source, and Wiki directories.
- The CHANGELOG.md, LICENSE.txt, README.md, and requirements.txt files.
- Create a config.yaml file from the contents of the Sample Config.

See Also

For a more in-depth explanation of the domain, its resources, and its locations, see Domain Design.