bbelderbos / codeimag.es

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pybites Code Images API

An API to create code images using pybites-carbon, upload them to an S3 bucket and host them in a central database.

This app currently runs on Heroku here:

codeimages-website

The API supports signup with email verification.

This repo also includes a script to authenticate and post tips to the API.

Setup

To run it locally create a virtual environment and install the dependencies

$ python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt
# or
$ make setup

Then run the server with:

$ uvicorn tips.main:app --reload
# or
$ make runserver

... and navigate to http://localhost:8000/docs

Dev tooling

For linting, type checking and pytest / coverage you can run the following commands:

$ make lint
$ make typing
$ make cov

Contributing

Any help to make this tool better is welcome, please log an issue here (for pybites-carbon related issues, use its repo here) - thanks.

About

License:MIT License


Languages

Language:Python 85.2%Language:HTML 8.7%Language:CSS 2.3%Language:JavaScript 2.2%Language:Mako 0.9%Language:Makefile 0.5%Language:Procfile 0.2%