Monochrome's API, implemented with Deta Base and Deta Drive.

Last update: Sep 22, 2022

Overview

Monochrome

Monochrome's API, implemented with Deta Base and Deta Drive.

Create a free account on Deta to test this out!

Most users will prefer the Monochrome full stack, which contains the API, the frontend and the backend.

Usage

Docker

This service is available on ghcr.io:

docker pull ghcr.io/monochromecms/monochrome-api-deta:latest

The database needs to be set up, and an admin user created:

docker run                                         \
  -e DETA_PROJECT_KEY=...                          \
  ghcr.io/monochromecms/monochrome-api-deta:latest \
  create_admin

Once done, the image can be launched with the required env. vars:

docker run -p 3000:3000                            \
  -e DETA_PROJECT_KEY=...                          \
  -e JWT_SECRET_KEY=changeMe                       \
  ghcr.io/monochromecms/monochrome-api-deta:latest

The images are stored on Deta Drive, they are available on the /media route or on the Deta Web UI.

Makefile

A Makefile is provided with this repository, to simplify the development and usage:

help                 Show this help message
up start             Run a container from the image, or start it natively
# Docker utils
build                Build image
logs                 Read the container's logs
sh                   Open a shell in the running container
# Dev utils
lock                 Refresh pipfile.lock
lint                 Lint project code
format               Format project code
# Main utils
secret               Generate a secret
create_admin         Create a new admin user
# Tests
test                 Run the tests

So the basic usage would be:

make create_admin
make start

.env

While using the Makefile, the image settings can be set with a .env file, see .env.example.

Native

Even though Docker is the recommended method, some Makefile rules are native compatible, so a virtual environment can also be used after cloning this repository:

#You need to be able to run these commands on your terminal:
tar, 7z, unrar, xz

pip install pipenv
pipenv shell
pipenv install

make native=1 install

Environment variables

# Deta project key, more info on https://deta.sh
DETA_PROJECT_KEY
# Comma-separated list of origins to allow for CORS, namely the origin of your frontend
CORS_ORIGINS = ""

# Secret used to sign the JWT
JWT_SECRET_KEY
# Algorithm used to sign the JWT
JWT_ALGORITHM = "HS256"
# Amount of minutes a JWT will be valid for
JWT_ACCESS_TOKEN_EXPIRE_MINUTES = 60

# Path where temporary data will be stored (DON'T CHANGE THIS IN DETA MICROS)
TEMP_PATH = "/tmp"

# For pagination, the maximum of elements per request, has to be positive
MAX_PAGE_LIMIT = 50
# Allows anyone to create a "user" account
ALLOW_REGISTRATION=False

Roles

Each used can have one of different roles, this is done to have a sort of hierarchy:

Admin

The role the create-admin command gives to the user, it's the highest role and grants all the permissions (user and website management, upload and editing of manga and chapters)

Uploader

This role can create new manga and upload new chapters, but can only edit/delete those that they have created themselves.

User

This user can only update its own user for now, it'll become more useful once other features are added to Monochrome (comments, notifications, reading progress...) You can already allow registrations via the respective env var, but it isn't recommended until meaningful features are added.

Tools used

FastAPI
Deta Base
Deta Drive
Pydantic

Progress

Creation 🟢 100% (new features can always be added)
Documentation 🟡 58%
OpenAPI 🟡 66%
Cleaner code 🟡 50%
Testing 🟠 40% (I still need to use this implementation throughly)
- Unit 🟢 100%
- Integration 🔴 10%

Credits:

Base API template: https://github.com/grillazz/fastapi-sqlalchemy-asyncpg
Deta documentation: https://docs.deta.sh

This repository contains a lot of short scripting programs implemented both in Python (Flask) and TypeScript (NodeJS).

fast-scripts This repository contains a lot of short scripting programs implemented both in Python (Flask) and TypeScript (NodeJS). In python These wi

3 Dec 10, 2022

Here is my Senior Design Project that I implemented to graduate from Computer Engineering.

Here is my Senior Design Project that I implemented to graduate from Computer Engineering. It is a chatbot made in RASA and helps the user to plan their vacation in the Turkish language. In order to plan the user's vacation, it provides reservations by asking various questions for hotel, flight, or event.

25 May 31, 2022

Comments

User roles
Admin: Same permissions as the previous regular user

Uploader: Can create new manga and chapters, but only edit those they have published themselves

User: Regular user with no special permission (besides logging out and updating its own user)
opened by D34DPlayer 0
Possible pagination leak

Right now for pagination the whole list of items is requested and only then counted and sorted.

This could be fixed if Deta provided a way to sort and count the total directly form the db.

In the meantime we can do the sorting after every request and keep the total in a variable. So that the list never gets above the requested limit.
bug

opened by D34DPlayer 0

Releases(v1.5.0)

v1.5.0(Nov 26, 2021)
Comments are here!

Prometheus metrics are now available on the /metrics route

When uploading webtoon chapters, there's now an option to optimize the slices

Source code(tar.gz)
Source code(zip)
v1.4.3(Nov 19, 2021)
We are moving to uvicorn for improved performance

The docker image is now way smaller

Tests fixed

Source code(tar.gz)
Source code(zip)
v1.4.2(Nov 15, 2021)

Refresh tokens are here!

This allow us to have access tokens that expire quickly (for security) while still allowing users to stay logged in for days.
Source code(tar.gz)
Source code(zip)
v1.4.1(Nov 7, 2021)
Fixed broken zip upload on windows.

Fixed broken uploads.

Source code(tar.gz)
Source code(zip)
v1.4.0(Oct 26, 2021)

v1.4.0b

Fixed a BIG issue with permissions (only a Deta issue)
Source code(tar.gz)
Source code(zip)
v1.3.0(Oct 20, 2021)

v1.3.0
Source code(tar.gz)
Source code(zip)
v1.2.3(Oct 16, 2021)

v1.2.3
Source code(tar.gz)
Source code(zip)
v1.2.2(Oct 16, 2021)

v1.2.2
Source code(tar.gz)
Source code(zip)

Monochrome's API, implemented with Deta Base and Deta Drive.

Related tags

Overview

Monochrome

Usage

Docker

Makefile

.env

Native

Environment variables

Roles

Admin

Uploader

User

Tools used

Progress

You might also like...

This repository contains a lot of short scripting programs implemented both in Python (Flask) and TypeScript (NodeJS).

Here is my Senior Design Project that I implemented to graduate from Computer Engineering.

This is the improvised version of Dobot Magician which can be implemented for Dobot M1

Neogex is a human readable parser standard, being implemented in Python

Black-Scholes library implemented as a Cairo smart contract

Process RunGap output file of a workout and load data into Apple Numbers Spreadsheet and my website with API calls

Wrappers around the most common maya.cmds and maya.api use cases

An unofficial python API for trading on the DeGiro platform, with the ability to get real time data and historical data.

This application demonstrates IoTVAS device discovery and security assessment API integration with the Rapid7 InsightVM.

Comments

User roles

Possible pagination leak

Releases(v1.5.0)

v1.5.0(Nov 26, 2021)

v1.4.3(Nov 19, 2021)

v1.4.2(Nov 15, 2021)

v1.4.1(Nov 7, 2021)

v1.4.0(Oct 26, 2021)

v1.3.0(Oct 20, 2021)

v1.2.3(Oct 16, 2021)

v1.2.2(Oct 16, 2021)

Owner

Monochrome

Odd-Or-Even - Ask the user for a number. Depending on whether the number is even or odd, print out an appropriate message to the user

A price calculator for multiple things

NES development tool made with Python and Lua

Streamlit — The fastest way to build data apps in Python

Data Applications Project

A curses based mpd client with basic functionality and album art.

🐍 A Python lib for (de)serializing Python objects to/from JSON

BDD base project: Python + Behave

A tool to nowcast quarterly data with monthly indicators: US consumption example

Software for visualization of RTStruct structures on CT images

a bit of my project :) and I use some of them for my school lesson or study for an exam! but some of them just for myself.

Our product DrLeaf which not only makes the work easier but also reduces the effort and expenditure of the farmer to identify the disease and its treatment methods.

monster hunter world randomizer project

Яндекс тренировки по алгоритмам. Июнь 2021

Minimalistic Gridworld Environment (MiniGrid)

Trackthis - This library can be used to track USPS and UPS shipments.

Get a list of content on your Netflix My List that is expiring in the next month or two.

An alternative site to emplea.do due to inconsistent service of the app.

The purpose of this code base is to add a specified signal-to-noise ratio noise from MUSAN dataset to a pure speech signal and to generate far-field speech data using room impulse response data from BUT [email protected] Reverb Database.

tidevice can be used to communicate with iPhone device