Merge pull request #204 from ikostan/main

Merge from master

Author: ikostan

tisbury-treasure-hunt/.exercism/config.json

@@ -0,0 +1,18 @@
+{
+  "authors": [
+    "BethanyG"
+  ],
+  "files": {
+    "solution": [
+      "tuples.py"
+    ],
+    "test": [
+      "tuples_test.py"
+    ],
+    "exemplar": [
+      ".meta/exemplar.py"
+    ]
+  },
+  "icon": "tisbury-treasure-hunt",
+  "blurb": "Learn about tuples by helping out competitors in the Tisbury Treasure Hunt."
+}

tisbury-treasure-hunt/.exercism/metadata.json

@@ -0,0 +1 @@
+{"track":"python","exercise":"tisbury-treasure-hunt","id":"d0695c14209341b39ef09f36acc77dd7","url":"https://exercism.org/tracks/python/exercises/tisbury-treasure-hunt","handle":"myFirstCode","is_requester":true,"auto_approve":false}

tisbury-treasure-hunt/HELP.md

@@ -0,0 +1,130 @@
+# Help
+
+## Running the tests
+
+We use [pytest][pytest: Getting Started Guide] as our website test runner.
+You will need to install `pytest` on your development machine if you want to run tests for the Python track locally.
+You should also install the following `pytest` plugins:
+
+- [pytest-cache][pytest-cache]
+- [pytest-subtests][pytest-subtests]
+
+Extended information can be found in our website [Python testing guide][Python track tests page].
+
+
+### Running Tests
+
+To run the included tests, navigate to the folder where the exercise is stored using `cd` in your terminal (_replace `{exercise-folder-location}` below with your path_).
+Test files usually end in `_test.py`, and are the same tests that run on the website when a solution is uploaded.
+
+Linux/MacOS
+```bash
+$ cd {path/to/exercise-folder-location}
+```
+
+Windows
+```powershell
+PS C:\Users\foobar> cd {path\to\exercise-folder-location}
+```
+
+<br>
+
+Next, run the `pytest` command in your terminal, replacing `{exercise_test.py}` with the name of the test file:
+
+Linux/MacOS
+```bash
+$ python3 -m pytest -o markers=task {exercise_test.py}
+==================== 7 passed in 0.08s ====================
+```
+
+Windows
+```powershell
+PS C:\Users\foobar> py -m pytest -o markers=task {exercise_test.py}
+==================== 7 passed in 0.08s ====================
+```
+
+
+### Common options
+- `-o` : override default `pytest.ini` (_you can use this to avoid marker warnings_)
+- `-v` : enable verbose output.
+- `-x` : stop running tests on first failure.
+- `--ff` : run failures from previous test before running other test cases.
+
+For additional options, use `python3 -m pytest -h` or `py -m pytest -h`.
+
+
+### Fixing warnings
+
+If you do not use `pytest -o markers=task` when invoking `pytest`, you might receive a `PytestUnknownMarkWarning` for tests that use our new syntax:
+
+```bash
+PytestUnknownMarkWarning: Unknown pytest.mark.task - is this a typo?  You can register custom marks to avoid this warning - for details, see https://docs.pytest.org/en/stable/mark.html
+```
+
+To avoid typing `pytest -o markers=task` for every test you run, you can use a `pytest.ini` configuration file.
+We have made one that can be downloaded from the top level of the Python track directory: [pytest.ini][pytest.ini].
+
+You can also create your own `pytest.ini` file with the following content:
+
+```ini
+[pytest]
+markers =
+    task: A concept exercise task.
+```
+
+Placing the `pytest.ini` file in the _root_ or _working_ directory for your Python track exercises will register the marks and stop the warnings.
+More information on pytest marks can be found in the `pytest` documentation on [marking test functions][pytest: marking test functions with attributes] and the `pytest` documentation on [working with custom markers][pytest: working with custom markers].
+
+Information on customizing pytest configurations can be found in the `pytest` documentation on [configuration file formats][pytest: configuration file formats].
+
+
+### Extending your IDE or Code Editor
+
+Many IDEs and code editors have built-in support for using `pytest` and other code quality tools.
+Some community-sourced options can be found on our [Python track tools page][Python track tools page].
+
+[Pytest: Getting Started Guide]: https://docs.pytest.org/en/latest/getting-started.html
+[Python track tools page]: https://exercism.org/docs/tracks/python/tools
+[Python track tests page]: https://exercism.org/docs/tracks/python/tests
+[pytest-cache]:http://pythonhosted.org/pytest-cache/
+[pytest-subtests]:https://github.com/pytest-dev/pytest-subtests
+[pytest.ini]: https://github.com/exercism/python/blob/main/pytest.ini
+[pytest: configuration file formats]: https://docs.pytest.org/en/6.2.x/customize.html#configuration-file-formats
+[pytest: marking test functions with attributes]: https://docs.pytest.org/en/6.2.x/mark.html#raising-errors-on-unknown-marks
+[pytest: working with custom markers]: https://docs.pytest.org/en/6.2.x/example/markers.html#working-with-custom-markers
+
+## Submitting your solution
+
+You can submit your solution using the `exercism submit tuples.py` command.
+This command will upload your solution to the Exercism website and print the solution page's URL.
+
+It's possible to submit an incomplete solution which allows you to:
+
+- See how others have completed the exercise
+- Request help from a mentor
+
+## Need to get help?
+
+If you'd like help solving the exercise, check the following pages:
+
+- The [Python track's documentation](https://exercism.org/docs/tracks/python)
+- The [Python track's programming category on the forum](https://forum.exercism.org/c/programming/python)
+- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
+- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
+
+Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
+
+Below are some resources for getting help if you run into trouble:
+
+- [The PSF](https://www.python.org) hosts Python downloads, documentation, and community resources.
+- [The Exercism Community on Discord](https://exercism.org/r/discord)
+- [Python Community on Discord](https://pythondiscord.com/) is a very helpful and active community.
+- [/r/learnpython/](https://www.reddit.com/r/learnpython/) is a subreddit designed for Python learners.
+- [#python on Libera.chat](https://www.python.org/community/irc/) this is where the core developers for the language hang out and get work done.
+- [Python Community Forums](https://discuss.python.org/)
+- [Free Code Camp Community Forums](https://forum.freecodecamp.org/)
+- [CodeNewbie Community Help Tag](https://community.codenewbie.org/t/help)
+- [Pythontutor](http://pythontutor.com/) for stepping through small code snippets visually.
+
+Additionally, [StackOverflow](http://stackoverflow.com/questions/tagged/python) is a good spot to search for your problem/question to see if it has been answered already.
+ If not - you can always [ask](https://stackoverflow.com/help/how-to-ask) or [answer](https://stackoverflow.com/help/how-to-answer) someone else's question.

tisbury-treasure-hunt/HINTS.md

@@ -0,0 +1,49 @@
+# Hints
+
+## General
+
+
+- [Tuples][tuples] are immutable [sequence Types][sequence types] that can contain any data type.
+- Tuples are [iterable][iterable].  If you need indexes as well as values, use [`enumerate()`][enumerate]
+- Elements within tuples can be accessed via [bracket notation][bracket notation], using a zero-based index from the left, or -1 from the right. Other [Common Sequence Operations][common sequence operations] can also be used when working with tuples.
+
+## 1. Extract coordinates
+
+- Remember: tuples allow access via _index_, using _brackets_. Indexes start from the left at zero.
+
+## 2. Format coordinates
+
+- Check [`class tuple`][class tuple] for more details on tuples.
+- Check [`class str`][class str] for more details on strings.
+
+## 3. Match coordinates
+
+- What methods could be used here for for [testing membership][testing membership]?.
+- Check [`class tuple`][class tuple] for more details on tuples.
+- Could you re-use your `convert_coordinate()` function?
+
+## 4. Combine matched records
+
+- Remember that tuples support all [common sequence operations][common sequence operations].
+- Could you re-use your `compare_records()` function here?
+
+## 5. "Clean up" & make a report of all records
+
+- Remember: tuples are _immutable_, but the contents can be accessed via _index_ using _bracket notation_.
+- Tuples don't have to use parentheses unless there is _ambiguity_.
+- Python has multiple methods of string formatting. [`str.format()`][str.format] and [`f-strings`][f-strings] are two very common ones.
+- There are multiple textual formatting options available via Pythons [`format specification mini-language`][format specification mini-language].
+
+
+[bracket notation]: https://stackoverflow.com/questions/30250282/whats-the-difference-between-the-square-bracket-and-dot-notations-in-python
+[class str]: https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str
+[class tuple]: https://docs.python.org/3/library/stdtypes.html#tuple
+[common sequence operations]: https://docs.python.org/3/library/stdtypes.html#common-sequence-operations
+[enumerate]: https://docs.python.org/3/library/functions.html#enumerate
+[f-strings]: https://docs.python.org/3/tutorial/inputoutput.html#formatted-string-literals
+[format specification mini-language]: https://docs.python.org/3/library/string.html#format-specification-mini-language
+[iterable]: https://docs.python.org/3/glossary.html#term-iterable
+[sequence types]: https://docs.python.org/3/library/stdtypes.html#typesseq
+[str.format]: https://docs.python.org/3/library/stdtypes.html#str.format
+[testing membership]: https://docs.python.org/3/reference/expressions.html#membership-test-operations
+[tuples]: https://docs.python.org/3/tutorial/datastructures.html#tuples-and-sequences