great-ai/README.md
2022-07-10 19:43:39 +02:00

63 lines
No EOL
2.2 KiB
Markdown

# ![logo](docs/media/favicon.ico) GreatAI
> GreatAI helps you easily transform your prototype AI code into production-ready software.
[![Sonar line coverage](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=coverage)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
[![Sonar technical debt](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=sqale_index)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
[![Sonar LoC](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=ncloc)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
[![Test](https://github.com/schmelczer/great-ai/actions/workflows/test.yml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/test.yml)
[![Publish on PyPI](https://github.com/schmelczer/great-ai/actions/workflows/publish.yaml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/publish.yaml)
[![Publish on DockerHub](https://github.com/schmelczer/great-ai/actions/workflows/docker.yaml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/docker.yaml)
[![Downloads](https://pepy.tech/badge/great-ai/month)](https://pepy.tech/project/great-ai)
[Check out the documentation here](https://great-ai.scoutinscience.com/).
## Find `great-ai` on [DockerHub](https://hub.docker.com/repository/docker/schmelczera/great-ai)
```sh
docker run -p6060:6060 schmelczera/great-ai
```
Find the dashboard at [http://localhost:6060](http://localhost:6060/dashboard/).
## Find `great-ai` on [PyPI](https://pypi.org/project/great-ai/)
```sh
pip install great-ai
```
```python
from great_ai import GreatAI
@GreatAI.create
def hello_world(name: str) -> str:
return f"Hello {name}!"
```
> Create a new file called `main.py`
Deploy by executing `great-ai main.py`
> Or: `great_ai main.py`
> Or: `python3 -m great_ai main.py`
Find the dashboard at [http://localhost:6060](http://localhost:6060/dashboard/).
### Contribute
#### Install
```sh
python3 -m venv --copies .env
source .env/bin/activate
python3 -m pip install flit
python3 -m flit install --symlink --deps=all
```
#### Documentation
```sh
mkdocs serve --dirtyreload
```