https://github.com/bbelderbos/codeimag.es

https://github.com/bbelderbos/codeimag.es

alembic fastapi hacktoberfest hacktoberfest2023 sqlmodel

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/bbelderbos/codeimag.es
• Owner: bbelderbos
• License: mit
• Created: 2021-12-19T07:24:05.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-12T19:59:19.000Z (8 months ago)
• Last Synced: 2024-02-12T20:53:21.300Z (8 months ago)
• Topics: alembic, fastapi, hacktoberfest, hacktoberfest2023, sqlmodel
• Language: Python
• Homepage:
• Size: 168 KB
• Stars: 16
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pybites Code Images API

An API to create code images using [pybites-carbon](https://github.com/PyBites-Open-Source/pybites-carbon), upload them to an S3 bucket and host them in a central database.

This app currently runs on Heroku [here](http://pybites-codeimages.herokuapp.com):



The API supports signup with email verification. 

This repo also includes a script to [authenticate and post tips to the API](https://github.com/bbelderbos/codeimag.es/blob/main/tips/post_snippet.py).

## 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](https://github.com/bbelderbos/codeimag.es/issues) (for pybites-carbon related issues, use its repo [here](https://github.com/PyBites-Open-Source/pybites-carbon)) - thanks.