Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vyvy-vi/botish-api
A Botish API
https://github.com/vyvy-vi/botish-api
async fastapi hacktoberfest python rest-api
Last synced: about 2 months ago
JSON representation
A Botish API
- Host: GitHub
- URL: https://github.com/vyvy-vi/botish-api
- Owner: Vyvy-vi
- License: bsd-3-clause
- Created: 2021-07-23T16:20:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T11:04:26.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T10:43:35.564Z (10 months ago)
- Topics: async, fastapi, hacktoberfest, python, rest-api
- Language: Python
- Homepage:
- Size: 234 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Botish API
This is an API originaly made for the [Heptagram Bot](https://github.com/Heptagram-Bot/) project, now under the [botish.xyz](https://api.botish.xyz/) domain, maintained by Vyvy-Vi.
For contributing to the project, check out the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
## Features
_Coming soon..._
## Requirements
- `Python` v3.7+
- `fastapi` (API framework)
- `poetry` (dependency manager)
- `uvicorn` (ASGI server)
- `pip` (needed to install poetry)
## Setting up the dev environment
1. Install Poetry
```
pip install poetry
```
2. Set up the project dependencies and the pre-commit hooks
```
poetry install
poetry run task precommit
```
3. Set up the MongoDB instance
4. Run the project
```
poetry run task start
```
5. Linting your code
```
poetry run task lint
```
## Usage