Skip to content

Latest commit

 

History

History
107 lines (83 loc) · 5.11 KB

README.md

File metadata and controls

107 lines (83 loc) · 5.11 KB
Raw

📚 AGHPB API

Behold the anime girls holding programming books API!

Docker Badge

This is an API I made for the anime girls holding programming books github repo because I was bored. It's a rewrite of the old API but written in Python using the Fast API library instead. It scrapes a local copy of the repo and thanks to that I was able to implement headers like Book-Date-Added (returns the date and time a book was added).

oh yeah also check out our 🌟 cousin API (anime girls and computers): https://github.com/r3tr0ananas/agac-api

🌐 Publicly available instances

Pick the closest instance to you for FASTER ANIME GIRLS!

Country URL Hosted by Notes
🇬🇧 https://api.devgoldy.xyz/aghpb/v1 me ⭐ Official Instance
🇩🇪 https://aghpb.teaishealthy.me teaishealthy
🇩🇪 https://api.ananas.moe/aghpb/v1 Ananas 🛠️ 🗣️ GERMAN ENGINEERING!!!
🇸🇪 https://aghpb.zeeraa.net Zeeraa
🇺🇸 https://api.emmatech.dev/aghpb EmmmaTech 🇺🇸 🦅 FREEDOMMMMMMMM!!!

Also do use these instances as backups incase my servers at https://api.devgoldy.xyz go down.

💫 API Wrappers

I was also even more bored so I decided to write an API wrapper in every mfing language I can possible, including those I've never really written in.

These are the languages I've written so far:

Then here are some community-made api wrappers ( thanks 💛 ):

🛠️ Wanna self-host?

If you would like to host your own instance of the aghpb API continue reading.

🐬 Docker Method (recommended)

Warning

The docker image currently only supports x86 architecture so if you are running anything else you may need to build the image yourself. For instructions on how to do that check out here.

The easiest method to host an instance is via our docker image. From now on in this section, I'm gonna assume you've had experience with Docker and you can at least complete the hello world tutorial.

Spinning up an aghpb API container in docker is pretty simple:

  1. First pull that mf
docker pull devgoldy/aghpb_api:latest
  1. Then launch a container with this command. -p binds the api to your localhost port 8000.
docker run -p 127.0.0.1:8000:8000/tcp devgoldy/aghpb_api:latest
  1. Now visit localhost:8000 in your browser and there you go! 👍

if you want to host via docker-compose, this file might be useful to you

⚗️ Building your own docker image.

To build your own docker image it is necessary you follow the native method's steps, but only up to step number 3 is necessary.

Once that is done run the command below:

make docker-build

docker images should display the "devgoldy/aghpb_api" image.

Now you may jump to step 2 of the docker method.

🐍 Native Method (recommended for development)

Prerequisites:

  1. Clone the repo.
git clone https://github.com/THEGOLDENPRO/aghpb_api && cd aghpb_api
  1. Create env.
python -m venv env
source env/bin/activate # For windows it's --> cd env/Scripts && activate && cd ../../
  1. Install the API's dependencies.
make
  1. Pull the anime girls programming books.
make pull-repo
  1. Run that sh#t.
make run
  1. Visit localhost:8000 in your browser, then all should be good! 🌈