Renaming and minor improvements

This commit is contained in:
Andras Schmelczer 2022-07-08 10:05:33 +02:00
parent 00714bef4e
commit dadbe24c82
5 changed files with 27 additions and 18 deletions

View file

@ -2,26 +2,26 @@
**work in progress, do not use!**
[![Test](https://github.com/ScoutinScience/great_ai/actions/workflows/test.yml/badge.svg)](https://github.com/ScoutinScience/great_ai/actions/workflows/check.yml)
[![Quality Gate Status](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=alert_status)](https://sonar.scoutinscience.com/dashboard?id=great_ai)
[![Publish on PyPI](https://github.com/ScoutinScience/great_ai/actions/workflows/publish.yaml/badge.svg)](https://github.com/ScoutinScience/great_ai/actions/workflows/publish.yaml)
[![Publish on DockerHub](https://github.com/ScoutinScience/great_ai/actions/workflows/docker.yaml/badge.svg)](https://github.com/ScoutinScience/great_ai/actions/workflows/docker.yaml)
[![Downloads](https://pepy.tech/badge/great_ai/month)](https://pepy.tech/project/great_ai)
[![Test](https://github.com/ScoutinScience/great-ai/actions/workflows/test.yml/badge.svg)](https://github.com/ScoutinScience/great-ai/actions/workflows/check.yml)
[![Quality Gate Status](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=alert_status)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
[![Publish on PyPI](https://github.com/ScoutinScience/great-ai/actions/workflows/publish.yaml/badge.svg)](https://github.com/ScoutinScience/great-ai/actions/workflows/publish.yaml)
[![Publish on DockerHub](https://github.com/ScoutinScience/great-ai/actions/workflows/docker.yaml/badge.svg)](https://github.com/ScoutinScience/great-ai/actions/workflows/docker.yaml)
[![Downloads](https://pepy.tech/badge/great-ai/month)](https://pepy.tech/project/great-ai)
## Find `great_ai` on [DockerHub](https://hub.docker.com/repository/docker/schmelczera/great_ai)
## Find `great-ai` on [DockerHub](https://hub.docker.com/repository/docker/schmelczera/great-ai)
```sh
docker run -p6060:6060 schmelczera/great_ai
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/)
## Find `great-ai` on [PyPI](https://pypi.org/project/great-ai/)
```sh
pip install great_ai
pip install great-ai
```
```python
@ -33,13 +33,14 @@ def hello_world(name: str) -> str:
```
> Create a new file called `main.py`
Deploy by executing `python3 -m great_ai main.py`
Deploy by executing `python3 -m great-ai main.py`
> Or: `python3 -m great-ai main.py`
Find the dashboard at [http://localhost:6060](http://localhost:6060/dashboard/).
### Contribute
```sh
pip install 'great_ai[dev]'
pip install 'great-ai[dev]'
```