https://github.com/caarmen/poet-assistant-drf

REST API for English-language tools for writing poetry (Django REST Framework)
https://github.com/caarmen/poet-assistant-drf

django-rest-framework python python3

Last synced: 11 days ago
JSON representation

REST API for English-language tools for writing poetry (Django REST Framework)

• Host: GitHub
• URL: https://github.com/caarmen/poet-assistant-drf
• Owner: caarmen
• License: gpl-3.0
• Created: 2022-02-27T17:15:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-16T02:29:32.000Z (about 2 years ago)
• Last Synced: 2023-03-24T00:21:38.761Z (over 1 year ago)
• Topics: django-rest-framework, python, python3
• Language: Python
• Homepage:
• Size: 16.8 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# poet-assistant-drf

Poet Assistant REST api using Django Rest Framework

[![GitHub license][license-image]][license-url]

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/caarmen/poet-assistant-drf/codecheck.yml?branch=main)](https://github.com/caarmen/poet-assistant-drf/actions/workflows/codecheck.yml?query=branch%3Amain)

[license-image]: https://img.shields.io/github/license/caarmen/poet-assistant-drf

[license-url]: https://raw.githubusercontent.com/caarmen/pylint-json2checkstyle/main/LICENSE

## Running

* Run the following commands:

    * `python3 -m venv env`

    * `source env/bin/activate`

    * `pip install -r requirements/dev.txt`

    * `python manage.py migrate`

    * `python manage.py runserver`

* Open the landing page at http://127.0.0.1:8000

## REST api documentation

See the [documentation](https://caarmen.github.io/poet-assistant-drf/) generated by openapi tools.

## Architecture

The app has the following architecture:



### Definitions and thesaurus entries

The endpoints for definitions and thesaurus entries are implemented using DRF Viewsets and

serializers and have logic limited to transforming the data as it's stored in the database into

the required format for the endpoint responses.

### Rhymes

The rhymes endpoint has a service layer to construct a complex raw SQL query to return the

rhymes for a word.

### Word of the day

The word of the day (wotd) endpoint has a service layer with some business logic:

- Minimal reimplementation of a random function, in order to have the same random results for

  a given seed as the word of the day feature provided by the

  [Android](https://github.com/caarmen/poet-assistant) and

  [iOS](https://github.com/caarmen/poet-assistant-ios) apps.

- Exclusion of too common or too rare words, based on a stem table in the database

### Common Api

Logic concerning pagination, search, and serialization, among the different endpoints, is

centralized in the commonapi package.