Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scarlettsamantha/scarlettbytes

Source of my private domains main page.
https://github.com/scarlettsamantha/scarlettbytes

flask python scarlett scarlettbytes-nl

Last synced: about 2 months ago
JSON representation

Source of my private domains main page.

Awesome Lists containing this project

README

        

# ScarlettBytes

This is the source of [scarlettbytes.nl](https://scarlettbytes.nl). This repository is here for transparency and to provide insights into the structure and content of my personal website.

## Overview

The website serves as a personal hub to host my GPG public key, CV, and links to various projects I am working on or have worked on etc...

## Development

## Endpoints

| Endpoint(s) | Methods | Description | Rate Limit | Parameters |
| ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `/gpg`, `/key` | GET | Returns the GPG public key in a preformatted HTML response. | 10 per minute | None |
| `/lshw-parser` | GET | Redirects to the lshw-parser GitHub repository. | 5 per minute | None |
| `/lshw-parser/download` | GET | Redirects to the latest release zip URL of the **lshw-parser** package, or returns a 404 error if not found. | 5 per minute | None |
| `/openciv` | GET | Redirects to the OpenCiv GitHub repository. | 5 per minute | None |
| `/openciv/download` | GET | Redirects to the latest release zip URL of the **OpenCiv** package, or returns a 404 error if not found. | 5 per minute | None |
| `/cv/download` | GET | Serves the CV PDF file as a downloadable attachment. | 10 per minute | None |
| `/cv/download/key` | GET | Serves the PGP signature file for the CV PDF as a downloadable attachment. | 10 per minute | None |
| `/cv` | GET | Serves the CV PDF file directly in the browser. | 10 per minute | None |
| `/equipment` | GET | Renders the equipment page template, including Git information. | 10 per minute | None |
| `/`, any unmatched path | GET | Renders the home page template, including Git information. This is a catch-all route for any paths not matched by other endpoints. | 10 per minute | None |
| `/datetime` | GET | Displays the current datetime. Supports optional URL parameters: `format` (datetime format string), `live` (`true` or `false`), `interval` (update interval in milliseconds). If `live` is `true`, the datetime updates at the specified interval using JavaScript. | 10 per minute | - `format`: string (default `"%Y-%m-%d %H:%M:%S"`). See [datetime format documentation](https://strftime.org/).
- `live`: `true` or `false` (default `false`).
- `interval`: integer in milliseconds (default `1000`). |

**Notes:**

- **Rate Limits** are enforced using Flask-Limiter.
- The `/datetime` endpoint allows you to customize the displayed datetime format and enable live updating via JavaScript.
- For the `format` parameter, you can refer to the [datetime format documentation](https://strftime.org/) for available format codes.
- The catch-all route (`/` and any unmatched path) renders the home page.