https://github.com/debapriya-source/marriage-match-making-python

https://github.com/debapriya-source/marriage-match-making-python

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/debapriya-source/marriage-match-making-python
• Owner: Debapriya-source
• Created: 2024-08-05T19:33:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-05T19:42:46.000Z (over 1 year ago)
• Last Synced: 2025-02-23T23:54:10.020Z (10 months ago)
• Language: Python
• Size: 78.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Report on “Marriage Matchmaking App Assignment”

**By:** Debapriya Das

## Approach

In line with the provided tasks, I undertook the following steps:

1. Examined the entire codebase.

2. Created test users using the pre-existing routes provided.

3. Added the following routes:

   - **`/users/update/{user_id}`**: Allows updating a user with the specified `user_id` using the PUT method. Only the fields to be updated need to be provided in JSON format.

   - **`/users/delete/{user_id}`**: Enables deletion of a user with the specified `user_id` using the DELETE method.

   - **`/users/matches/{user_id}`**: Finds potential matches for the user associated with the provided `user_id`. The file `./matches.py` contains the function definition for finding matching users.

   - **`/users/validate-email`**: Validates any email address provided in the request body.

     - Added a new schema `EmailRequest` in the `./schemas.py`.

     - The email format is first checked using regular expressions.

     - The domain name is then verified using `dns.resolver` to ensure it is valid and has MX records.

     - The file `./check_email.py` contains the function definition for email validation.

4. For each route all the possible error-handling the status-code responses are implemented.

## Assumptions

To complete the project, the following assumptions were made:

- **Finding Matches:**

  - Matchings are based solely on similar interests.

  - The matching algorithm identifies similar users of the opposite gender only.

- **Email Validation:**

  - An endpoint was added to validate any email address requested.

  - Email validation is also applied during the creation and updating of user data.

## Testing

- Added route **`/users/populate`** to create bulk users for testing purposes. This route accepts an array of users in JSON format as the request body.