Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lakhindarpal/programming-meme-api
An api to get random programming memes built using FastApi
https://github.com/lakhindarpal/programming-meme-api
api fastapi memes memes-api programming-memes python
Last synced: 3 days ago
JSON representation
An api to get random programming memes built using FastApi
- Host: GitHub
- URL: https://github.com/lakhindarpal/programming-meme-api
- Owner: LakhindarPal
- License: mit
- Created: 2024-04-03T20:00:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-05T03:17:20.000Z (7 months ago)
- Last Synced: 2024-10-12T13:12:29.946Z (about 1 month ago)
- Topics: api, fastapi, memes, memes-api, programming-memes, python
- Language: Python
- Homepage: https://memes.cyclic.app/docs
- Size: 24.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Programming Meme API
Welcome to the Programming Meme API! This API provides a collection of humorous programming memes to brighten up your coding sessions. With customizable filtering options, you can easily find memes that match your preferences.
## Features
- Retrieve random programming memes
- Filter memes based on dimensions (max-width, max-height, min-width, min-height)
- Simple and intuitive API endpoints
## Check Live
Check the api [https://memes.cyclic.app/api](https://memes.cyclic.app/api)
## Documentation
For detailed documentation on how to use the API, please refer to the API documentation.
[Docs - Swagger UI](https://memes.cyclic.app/docs)
[ReDoc](https://memes.cyclic.app/redoc)
## Technologies
- Python
- FastApi
- cyclic.sh
## Deploy to Cyclic in seconds
[](https://deploy.cyclic.app/)
Set `server.py` as your entry point.
## Run Locally
To get started, clone the repository:
```bash
git clone https://github.com/LakhindarPal/programming-meme-api.git
```
### Prerequisites:
- python 3.10.11
### Setup
1. Navigate to the project directory.
```bash
cd programming-meme-api
```
2. Install: `bin/install`
- creates virtual env
- installs dependencies from `requirements.txt`
3. Run: `bin/dev`
- runs a `uvicorn` server in reload mode
4. Run: `bin/start`
- runs a `uvicorn` server
The API will now be running locally at `http://localhost:8000`.
## Try the server
Schema docs: [http://localhost:8181/docs](http://localhost:8181/docs)
Test:
`curl -i -XGET http://localhost:8181/`
Main Api:
`curl -i -XGET http://localhost:8181/api`
## Acknowledgment
The memes used in this API are collected from [this repo](https://github.com/deep5050/programming-memes). I would like to thank **Dipankar Pal** for creating that awesome collection.
## Contributing
Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE).