andras/great-ai
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 4 Packages Wiki Activity Actions

Renaming and minor improvements

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/docker.yaml vendored
View file

@ -28,7 +28,7 @@ jobs:
id: meta id: meta
uses: docker/metadata-action@v4 uses: docker/metadata-action@v4
with: with:
images: schmelczera/great_ai images: schmelczera/great-ai
- name: Build and push - name: Build and push
uses: docker/build-push-action@v3 uses: docker/build-push-action@v3

3
.vscode/settings.json vendored
View file

@ -69,6 +69,9 @@
"python.testing.pytestArgs": [ "python.testing.pytestArgs": [
"tests" "tests"
], ],
"python.linting.flake8Enabled": false,
"python.linting.pylintEnabled": false,
"python.linting.mypyEnabled": true,
"python.testing.unittestEnabled": false, "python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true "python.testing.pytestEnabled": true
} }

2
Dockerfile
View file

@ -3,7 +3,7 @@ FROM python:3.10.4-slim-bullseye
LABEL org.opencontainers.image.title="GreatAI package wrapper container" LABEL org.opencontainers.image.title="GreatAI package wrapper container"
LABEL org.opencontainers.image.vendor="ScoutinScience B.V." LABEL org.opencontainers.image.vendor="ScoutinScience B.V."
LABEL org.opencontainers.image.authors="andras@schmelczer.dev" LABEL org.opencontainers.image.authors="andras@schmelczer.dev"
LABEL org.opencontainers.image.source="https://github.com/ScoutinScience/great_ai" LABEL org.opencontainers.image.source="https://github.com/ScoutinScience/great-ai"
ENV ENVIRONMENT=production ENV ENVIRONMENT=production
EXPOSE 6060 EXPOSE 6060

23
README.md
View file

@ -2,26 +2,26 @@
**work in progress, do not use!** **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) [![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) [![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 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) [![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) [![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 ```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 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 ```sh
pip install great_ai pip install great-ai
``` ```
```python ```python
@ -33,13 +33,14 @@ def hello_world(name: str) -> str:
``` ```
> Create a new file called `main.py` > 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/). Find the dashboard at [http://localhost:6060](http://localhost:6060/dashboard/).
### Contribute ### Contribute
```sh ```sh
pip install 'great_ai[dev]' pip install 'great-ai[dev]'
``` ```

15
pyproject.toml
View file

@ -2,8 +2,11 @@
requires = ["flit_core >=3.2,<4"] requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi" build-backend = "flit_core.buildapi"
[tool.flit.module]
name = "great_ai" # Module's import name/local folder name
[project] [project]
name = "great_ai" name = "great-ai" # PyPI package name
dynamic = ["version", "description"] dynamic = ["version", "description"]
readme = "README.md" readme = "README.md"
authors = [{ name = "András Schmelczer", email = "andras@schmelczer.dev" }] authors = [{ name = "András Schmelczer", email = "andras@schmelczer.dev" }]
@ -59,9 +62,11 @@ dev = [
] ]
[project.urls] [project.urls]
Homepage = "https://github.com/ScoutinScience/great_ai" Homepage = "https://github.com/ScoutinScience/great-ai"
DockerHub = "https://hub.docker.com/repository/docker/schmelczera/great_ai" DockerHub = "https://hub.docker.com/repository/docker/schmelczera/great-ai"
[project.scripts] [project.scripts]
great_ai = "great_ai:main" great_ai = "great_ai.__main__:main"
large_file = "great_ai.large_file:main" great-ai = "great_ai.__main__:main"
large_file = "great_ai.large_file.__main__:main"
large-file = "great_ai.large_file.__main__:main"