Skip to content

Commit

Permalink
Fix typo in readme and add tests
Browse files Browse the repository at this point in the history
  • Loading branch information
whisperingpixel committed Jan 28, 2019
1 parent 1a75b7a commit 6a26a0d
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 10 deletions.
18 changes: 12 additions & 6 deletions README.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": 2,
"metadata": {},
"outputs": [
{
Expand All @@ -169,7 +169,7 @@
"'t33uvp-2017-005-01-6'"
]
},
"execution_count": 1,
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
Expand Down Expand Up @@ -212,10 +212,16 @@
"Create and activate the conda environment\n",
"\n",
"```bash\n",
"conda evn create -f environment.yml\n",
"conda env create -f environment.yml\n",
"activate sentinel-tools\n",
"```\n",
"\n",
"You may run the tests to verify that it is working properly\n",
"\n",
"```bash\n",
"coverage run -m s2_idgen.test_s2_idgen\n",
"```\n",
"\n",
"This is made for working with Jupyter Lab. You may want to install the current envionment as kernel:\n",
"\n",
"```bash\n",
Expand Down Expand Up @@ -261,9 +267,9 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python [conda env:sentinel-tools]",
"display_name": "sentinel-tools",
"language": "python",
"name": "conda-env-sentinel-tools-py"
"name": "sentinel-tools"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -275,7 +281,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.2"
"version": "3.4.4"
}
},
"nbformat": 4,
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,16 @@ cd sentinel-2-id-generator
Create and activate the conda environment

```bash
conda evn create -f environment.yml
conda env create -f environment.yml
activate sentinel-tools
```

You may run the tests to verify that it is working properly

```bash
coverage run -m s2_idgen.test_s2_idgen
```

This is made for working with Jupyter Lab. You may want to install the current envionment as kernel:

```bash
Expand Down
13 changes: 10 additions & 3 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Version 2 might be something like this: >
Use the package as follows


+*In[1]:*+
+*In[2]:*+
[source, ipython3]
----
#
Expand All @@ -131,7 +131,7 @@ id.getID()
----


+*Out[1]:*+
+*Out[2]:*+
----'t33uvp-2017-005-01-6'----

== 6. Development
Expand All @@ -154,10 +154,17 @@ Create and activate the conda environment

[source,bash]
----
conda evn create -f environment.yml
conda env create -f environment.yml
activate sentinel-tools
----

You may run the tests to verify that it is working properly

[source,bash]
----
coverage run -m s2_idgen.test_s2_idgen
----

This is made for working with Jupyter Lab. You may want to install the
current envionment as kernel:

Expand Down

0 comments on commit 6a26a0d

Please sign in to comment.