adrielklein / anagram-server Goto Github PK

AnagramServer is a web server that provides an API to load words into a data store and find their anagrams. In addition, the API provides routes to remove words, clear the data store, and show statistics about the words.

• GET /: Returns HTML. This is the main route for interacting with the application.
• POST /words.json: Takes a JSON array of words and adds them to the corpus (data store).
• GET /anagrams/:word.json:
  • Returns a JSON array words that are anagrams of the word passed in the URL.
  • Supports an optional query param that indicates the maximum number of results to return.
• DELETE /words/:word.json: Deletes a single word from the data store.
• DELETE /words.json: Deletes all contents of the data store.
• GET /stats: Returns a JSON object specifying the count of words in the corpus and min/max/median/average word length
• GET /most: Returns a JSON object that identifies alphagrams in the corpus with the most anagrams

1. Download and install Python 3.5
2. Clone this repository to your machine
3. Open a terminal and change into the root of the repository
4. Install virtualenv pip install virtualenv
5. Create a virtual environment virtualenv venv
6. Activate the virtual environment source venv/bin/activate
7. Install Dependencies pip install -r requirements.txt

• Run python start_server.py

• Run python scripts/run_tests.py

1. Make sure the server is running
2. Run python scripts/populate_corpus.py

The server is written in Python and uses Flask as a web framework.

The data store is an in-memory hash table where the key is an alphagram and the value is a set of words that map to that alphagram.

For example, the alphagram "dgo" maps to a set containing the words "dog" and "god".

The hash table makes anagram lookups easy. To find an anagram for a word the server simply finds its alphagram, looks it up in the hash table, and returns the corresponding set.