Metadata-Version: 2.1
Name: impressive-strawberry
Version: 0.3.3
Summary: Achievements-as-a-service
Home-page: https://impressive-strawberry.ryg.one/
License: AGPL-3.0-or-later
Keywords: achievements,fastapi,backend,strawberry,webapi
Author: Stefano Pigozzi
Author-email: me@steffo.eu
Maintainer: Stefano Pigozzi
Maintainer-email: me@steffo.eu
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet
Classifier: Typing :: Typed
Requires-Dist: SQLAlchemy (>=1.4.26,<2.0.0)
Requires-Dist: alembic (>=1.7.4,<2.0.0)
Requires-Dist: fastapi (>=0.70.0,<0.71.0)
Requires-Dist: httpx (>=0.21.1,<0.22.0)
Requires-Dist: lazy-object-proxy (>=1.6.0,<2.0.0)
Requires-Dist: psycopg2-binary (>=2.9.1,<3.0.0)
Requires-Dist: pytest-cov (>=3.0.0,<4.0.0)
Requires-Dist: python-dotenv (>=0.19.1,<0.20.0)
Requires-Dist: uvicorn (>=0.15.0,<0.16.0)
Project-URL: Documentation, https://hub.ryg.one/impressive-strawberry/
Project-URL: Repository, https://github.com/RYGhub/impressive-strawberry/
Description-Content-Type: text/markdown

# Impressive Strawberry

_Achievements-as-a-service_

## About

Impressive Strawberry is a Web API that allows the consumer applications to manage user-unlockable achievements, and for external applications to unlock them
for the users, notifying them in the process.

## Development

### Design document

The design document was made [on FigJam](https://www.figma.com/file/8J7exqW3srh0WNiICHnf0O/Medals?node-id=0%3A1).

### Documentation

Documentation is made available [via GitHub Pages](https://hub.ryg.one/impressive-strawberry/).

### Tasks

Tasks to be done are published [on GitHub Issues](https://github.com/RYGhub/impressive-strawberry/issues).

If you **find a bug**, a **mistake**, or want to **suggest a new feature**,
please [create a new issue](https://github.com/RYGhub/impressive-strawberry/issues/new)!

### Pull requests

Feel free to fork the project and continue developing it, but remember to [respect the AGPL 3.0+ license](LICENSE.txt)!

If you want to contribute back to the main branch, please [open a new pull request](https://github.com/RYGhub/impressive-strawberry/pulls)!

### Discussion

A forum about the project is available [on GitHub Discussions](https://github.com/RYGhub/impressive-strawberry/discussions).

If you want to **talk about the project**, or **ask a question** or even **help**,
please [create a new discussion](https://github.com/RYGhub/impressive-strawberry/discussions/new)!

### CI / CD

CI and CD for this project is hosted [on GitHub Actions](https://github.com/RYGhub/impressive-strawberry/actions).

[![🔨 Steffo's Python Poetry Workflow](https://github.com/RYGhub/impressive-strawberry/actions/workflows/stefflow.yml/badge.svg)](https://github.com/RYGhub/impressive-strawberry/actions/workflows/stefflow.yml)

#### Jobs

- _Tests_ are run **on every push** and **on every pull request**.
- _CodeQL_ is run **every monday at 10:10 AM**.
- _Build and publish_ are run **on every release**.

All jobs can be triggered simultaneously by pressing the **Run Workflow**
button [on the Workflow page](https://github.com/RYGhub/impressive-strawberry/actions/workflows/stefflow.yml).

### Roadmap

The roadmap is published [on GitHub Projects](https://github.com/orgs/RYGhub/projects/1/views/1).

### Security

Please report security vulnerabilities via email at `security@steffo.eu`.

