https://github.com/r-priyam/fastapi-coc.py
A simple FastAPI app to demonstrate the use with coc.py
https://github.com/r-priyam/fastapi-coc.py
clash-of-clans coc fastapi python python3
Last synced: about 2 months ago
JSON representation
A simple FastAPI app to demonstrate the use with coc.py
- Host: GitHub
- URL: https://github.com/r-priyam/fastapi-coc.py
- Owner: r-priyam
- Created: 2021-12-30T07:14:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T23:39:13.000Z (about 2 years ago)
- Last Synced: 2024-04-08T01:04:38.998Z (about 2 years ago)
- Topics: clash-of-clans, coc, fastapi, python, python3
- Language: Python
- Homepage:
- Size: 727 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## **A simple [FastAPI](https://github.com/tiangolo/fastapi) app to demonstrate the use with [coc.py](https://github.com/mathsman5133/coc.py)**
## Inroduction
This simple application uses the `coc.py` library to interact with `Clash of Clans` in game API and the `FastAPI` framework to server the data using `jinja2` templates.
## Features
- 📄 Jinja2 templates
- ✒️ Fully type-safe code (checked with [`Pyright`](https://github.com/microsoft/pyright)).
- 🚀 It actually works!
## Important Links
- [FastAPI Documentation](https://fastapi.tiangolo.com/)
- [coc.py Documentation](https://cocpy.readthedocs.io/en/latest/)
- [Starlette's docs](https://www.starlette.io/templates/)
## Before you start
Please make sure that you have these requirements ready:
- Python **3.9+**
- Poetry, for dependency management. Follow the [installation instructions](https://python-poetry.org/docs/#installation) to install it.
- GIT, for version control and also to clone this repo. Follow [installation instructions](https://git-scm.com/) to install it.
- Nothing else but however basic knowledge of `Python` and `FastAPI`.
## Getting Started
1. Clone the project using `git clone https://github.com/r-priyam/fastapi-coc.py.git`
2. Run `poetry install` to install the dependencies.
3. Rename `.env.example` to `.env` and fill in the required values.
- `COC_EMAIL`: Your email from `https://developer.clashofclans.com/`
- `COC_PASSWORD`: Your password from `https://developer.clashofclans.com/`
- `COC_KEY_NAME`: Name to create API key with.
All set now, turn the 💡 on by running - `poetry run task dev`. Once application started, visit - `http://127.0.0.1:8000/player/2pp` in your browser and done. Change player tag to whatever you want to and it will display that player information.
If you have any questions or suggestions, please feel free to open an issue [here](https://github.com/r-priyam/fastapi-coc.py/issues/new).