sartography
/
cr-connect-workflow
mirror of https://github.com/sartography/cr-connect-workflow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
15 Commits 13 Branches 0 Tags 8.7 MiB
Python 98.2%
HTML 1%
Shell 0.7%
Go to file
Dan Funk 92ce0d048a Creating an "app" base directory - this allows us to organize the source files and keep them separate from tests, configuration, and pipenv stuffs. Adding basic config and test directories and getting that set up and ready to roll. 2019-11-21 09:22:42 -05:00
app Creating an "app" base directory - this allows us to organize the source files and keep them separate from tests, configuration, and pipenv stuffs. Adding basic config and test directories and getting that set up and ready to roll. 2019-11-21 09:22:42 -05:00
readme_images Updates to the README and removing a problematic dependency 2019-11-20 17:00:02 -05:00
schema Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
tests Creating an "app" base directory - this allows us to organize the source files and keep them separate from tests, configuration, and pipenv stuffs. Adding basic config and test directories and getting that set up and ready to roll. 2019-11-21 09:22:42 -05:00
.gitignore Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
LICENSE.md Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
Pipfile Updates to the README and removing a problematic dependency 2019-11-20 17:00:02 -05:00
Pipfile.lock Updates to the README and removing a problematic dependency 2019-11-20 17:00:02 -05:00
README.md Updates to the README and removing a problematic dependency 2019-11-20 17:00:02 -05:00
run.py Creating an "app" base directory - this allows us to organize the source files and keep them separate from tests, configuration, and pipenv stuffs. Adding basic config and test directories and getting that set up and ready to roll. 2019-11-21 09:22:42 -05:00

README.md

CR Connect Workflow Microservice

Development Setup

Tools

These instructions assume you're using these development and tools:

  • IDE: PyCharm Professional Edition
  • Operating System: Ubuntu

Environment Setup

Make sure all of the following are properly installed on your system:

  1. python3 & pip3:
  2. pipenv:

Project Initialization

  1. Clone this repository.

  2. In PyCharm:

    • Go to File > New Project...
    • Click Pure Python (NOT Flask!!)
    • Click the folder icon in the Location field.
    • Select the directory where you cloned this repository and click Ok.
    • Expand the Project Interpreter section.
    • Select the New environment using radio button and choose Pipenv in the dropdown.
    • Under Base interpreter, select Python 3.6
    • In the Pipenv executable field, enter /home/your_username_goes_here/.local/bin/pipenv
    • Click Create Project Interpreter

  3. PyCharm should automatically install the necessary packages via pipenv. For me, the project interpreter did not set set up for me correctly on first attempt. I had to go to File -> Settings -> Project Interpreter and again set the project to use the correct PipEnv environment. Be sure that your settings like simliar to this, or attempt to add the interpreter again by clicking on the gear icon. Project Interpreter Settings screen

  4. With this properly setup for the project, you can now right click on the run.py and set up a new run configuration and set up a run configuration that looks like the following (be sure to save this run configuration so it doesn't go away.) : Run Configuration Screenshot

Running the project

Just click the "Play" button next to RUN in the top right corner of the screen. The Swagger based view of the API will be avialable at http://0.0.0.0:5000/v1.0/ui/