Skip to content

Commit 04a35f9

Browse files
committed
Update README
1 parent b465a0d commit 04a35f9

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

Diff for: README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
1-
# Distributed-HelloWorld
1+
# Distributed-Testing
22

33
[Distributed-Something](https://github.com/DistributedScience/Distributed-Something) is an app to run encapsulated docker containers that do... something in the Amazon Web Services (AWS) infrastructure.
44
We are interested in scientific image analysis so we have used it for [CellProfiler](https://github.com/DistributedScience/Distributed-CellProfiler), [Fiji](https://github.com/DistributedScience/Distributed-Fiji), and [BioFormats2Raw](https://github.com/DistributedScience/Distributed-OmeZarrMaker).
55
You can use it for whatever you want!
66

7-
Here, as an example, we have used it to make an app that lets you say hello to the world, as well as list some of your favorite things.
8-
We have provided Distributed-HelloWorld to assist you in the creation of your own Distributed-Something application.
9-
You can see the full code changes necessary to make a simple, functioning application from the [Distributed-Something template](https://github.com/DistributedScience/Distributed-Something).
10-
The full code changes are available [here](https://github.com/DistributedScience/Distributed-HelloWorld/pull/1/files).
7+
[Distributed-HelloWorld](https://github.com/DistributedScience/Distributed-HelloWorld) uses it to make a simple app that lets you say hello to the world, as well as list some of your favorite things.
118

12-
Like any Distributed-Something applicaton, to make it run, a user still needs to add their AWS-account specific information.
9+
Here, we reimplement Distributed-HelloWorld, with a testing suite.
10+
11+
Like any Distributed-Something applicaton, to make it run in AWS, a user still needs to add their AWS-account specific information.
12+
13+
The test suite however is run locally, using [moto](https://docs.getmoto.org/en/latest/) to mock AWS infastructure. This lets you make changes and test them without concern for breaking thins on live AWS infrastructure (and incur the associated costs).
14+
15+
## Tests
16+
17+
To run the tests, setup a virtual environment using your tool of choice (eg `venv`. `conda`, etc), and install the depedencies:
18+
19+
pip install -r requirements.txt
20+
21+
Run `pytest` in the terminal.
1322

1423
Happy Distributing!
1524

0 commit comments

Comments
 (0)