https://github.com/xsalagarcia/my_notes_api

A simple API to serve docs in markdown
https://github.com/xsalagarcia/my_notes_api

fastapi python redis sqlmodel

Last synced: 9 months ago
JSON representation

A simple API to serve docs in markdown

• Host: GitHub
• URL: https://github.com/xsalagarcia/my_notes_api
• Owner: xsalagarcia
• License: apache-2.0
• Created: 2025-03-10T08:45:34.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-03-17T06:12:52.000Z (10 months ago)
• Last Synced: 2025-03-27T06:18:10.381Z (9 months ago)
• Topics: fastapi, python, redis, sqlmodel
• Language: Python
• Homepage:
• Size: 43 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# API to serve notes in markdown

This will be a simple API to serve docs in markdown. 

## TODO list

- Deployment

### Wish list 

- Auto-categorization and auto-tag of uploaded markdowns.

## Data models

```mermaid

erDiagram

    NOTE {

        int id

        string name

        datetime last_updated

        string abstract

        bool is_public

        int category_id FK "to CATEGORY"

    }

    CATEGORY {

        int id

        string name UK

    }

    

    TAG {

        int id

        string name UK "UK with category_id"

        int category_id UK, FK "FK to CATEGORY, UK with name"

    }

    

    NOTETAGLINK {

        int id

        int tag_id FK "to TAG"

        int note_id FK "to NOTE"

    }

    CATEGORY ||--o{ NOTE : ""

    NOTETAGLINK }o--o| TAG: ""

    NOTETAGLINK }o--o| NOTE: ""

```

## Endpoints

Autodocumented. See swagger ui.

# Running all unit tests from CLI

Better to set the environment variable IN_MEMORY_DB="Yes":

```sh

env IN_MEMORY_DB="Yes" python -m unittest

```