Skip to content

Commit f651eb1

Browse files
authored
Merge pull request #6 from antmendoza/project-structure
improve project structure
2 parents 12d2b24 + 0066726 commit f651eb1

17 files changed

+34
-27
lines changed

Pipfile.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,14 @@ With the SDK you can:
1414

1515
- Python 3 required
1616

17+
- pipenv required `pip install pipenv`
18+
1719
```
1820
pipenv install
19-
python setup.py pytest
20-
```
2121
22-
If you get issues about missing modules:
22+
pipenv shell
2323
24-
```
25-
pip3 install jsonschema
26-
pip3 install pyyaml
24+
python setup.py pytest
2725
```
2826

2927
## **WIP** Programmatically build workflow definitions
@@ -69,7 +67,7 @@ functions:
6967
workflow = Workflow.from_source(swf_content)
7068
```
7169

72-
You can see a full example in the [test_workflow.py](./tests/test_workflow.py) file
70+
You can see a full example in the [test_workflow.py](tests/serverlessworkflow/sdk/test_workflow.py) file
7371

7472

7573
### Parse workflow to JSON / YAML
@@ -88,7 +86,7 @@ print(workflow.to_json())
8886
print(workflow.to_yaml())
8987
```
9088

91-
You can see a full example in the [test_workflow.py](./tests/test_workflow.py) file
89+
You can see a full example in the [test_workflow.py](tests/serverlessworkflow/sdk/test_workflow.py) file
9290

9391

9492
## Validate workflow definitions
@@ -108,4 +106,4 @@ WorkflowValidator(Workflow(workflow)).validate()
108106
```
109107
The `validate` method will raise an exception if the provided workflow does not complaint specification.
110108

111-
You can see a full example in the [test_workflow_validator](./tests/test_workflow_validator.py) file
109+
You can see a full example in the [test_workflow_validator](tests/serverlessworkflow/sdk/test_workflow_validator.py) file
File renamed without changes.

serverlessworkflow/sdk/__init__.py

Whitespace-only changes.
File renamed without changes.

serverlessworkflow_sdk/inject_state.py renamed to serverlessworkflow/sdk/inject_state.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from serverlessworkflow_sdk.state import State
1+
from serverlessworkflow.sdk.state import State
22

33

44
class InjectState(State):

serverlessworkflow_sdk/operation_state.py renamed to serverlessworkflow/sdk/operation_state.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
from serverlessworkflow_sdk.action import Action
2-
from serverlessworkflow_sdk.state import State
1+
from serverlessworkflow.sdk.action import Action
2+
from serverlessworkflow.sdk.state import State
33

44

55
class OperationState(State):
File renamed without changes.

serverlessworkflow_sdk/workflow.py renamed to serverlessworkflow/sdk/workflow.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
import yaml
44

5-
from serverlessworkflow_sdk.inject_state import InjectState
6-
from serverlessworkflow_sdk.operation_state import OperationState
7-
from serverlessworkflow_sdk.state import State
5+
from serverlessworkflow.sdk.inject_state import InjectState
6+
from serverlessworkflow.sdk.operation_state import OperationState
7+
from serverlessworkflow.sdk.state import State
88

99

1010
def is_inject_state(state: State):

serverlessworkflow_sdk/workflow_validator.py renamed to serverlessworkflow/sdk/workflow_validator.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import json
22
import requests
33
from jsonschema.validators import validate
4-
from serverlessworkflow_sdk.workflow import Workflow
4+
5+
from serverlessworkflow.sdk.workflow import Workflow
56

67

78
class WorkflowValidator:

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy