Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
muazhari committed Aug 7, 2024
1 parent 6b63ab0 commit 41a39d2
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 21 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# autocode

Auto Code Improvement by Technical Metrics Optimization.
Auto Code Improvement by Metrics Optimization.

## Description

Expand All @@ -28,24 +28,26 @@ companies.
pip install autocode-py
```

2. Prepare software to be processed as in the `./example/client` folder.
3. Prepare deployment as in the `./example/client-compose.yml` file.
3. Prepare controller as in the `./example/controller.ipynb` file.
4. Run the process in controller.
5. Open dashboard in `http://localhost:{dashboard_port}/` to see the process in real-time.
6. Wait until the process is finished.
7. Analyze and decide the best values.
2. Prepare software to be processed as in the [`./example/client`](https://github.com/muazhari/autocode/tree/main/example/client) folder.
3. Prepare deployment as in the [`./example/client/docker-compose.yml`](https://github.com/muazhari/autocode/blob/main/example/client/docker-compose.yml) file.
4. Prepare controller as in the [`./example/controller.ipynb`](https://github.com/muazhari/autocode/blob/main/example/controller.ipynb) file.
5. Instantiate `optimization` and execute `optimization.deploy()` in controller.
6. Open dashboard in `http://localhost:{dashboard_port}/` to see the process in real-time.
7. Wait until all client are ready.
8. Execute `optimization.run()` in controller.
9. Wait until the run is finished.
10. Analyze and decide the best values.

## Demo

- [Controller](https://github.com/muazhari/autocode/blob/main/example/controller.ipynb)
- [Client](https://github.com/muazhari/autocode/tree/main/example)
- [Client](https://github.com/muazhari/autocode/tree/main/example/client)
- Dashboard
![demo-1.png](https://github.com/muazhari/autocode/blob/main/demo-1.png?raw=true)

## Compatibility

- Python 3.10
- Python 3.10, 3.11
- Linux
- Docker
- [autocode-go](https://github.com/muazhari/autocode-go)
12 changes: 6 additions & 6 deletions example/client-compose.yml → example/client/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ services:
app-gateway:
image: muazhari/autocode-example-app-gateway:latest
build:
context: ./client/app_gateway
context: ./app_gateway
dockerfile: .Dockerfile
command:
- go
- test
- ./test
- -timeout=0
volumes:
- ./client/app_gateway:/workdir
- ./app_gateway:/workdir
extra_hosts:
- "host.docker.internal:host-gateway"
environment:
Expand All @@ -23,15 +23,15 @@ services:
app-account:
image: muazhari/autocode-example-app-account:latest
build:
context: ./client/app_account
context: ./app_account
dockerfile: .Dockerfile
command:
- go
- test
- ./test
- -timeout=0
volumes:
- ./client/app_account:/workdir
- ./app_account:/workdir
extra_hosts:
- "host.docker.internal:host-gateway"
environment:
Expand All @@ -40,15 +40,15 @@ services:
app-product:
image: muazhari/autocode-example-app-product:latest
build:
context: ./client/app_product
context: ./app_product
dockerfile: .Dockerfile
command:
- go
- test
- ./test
- -timeout=0
volumes:
- ./client/app_product:/workdir
- ./app_product:/workdir
extra_hosts:
- "host.docker.internal:host-gateway"
deploy:
Expand Down
2 changes: 1 addition & 1 deletion example/controller.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
"from typing import List\n",
"\n",
"docker_clients: List[DockerClient] = optimization.deploy(\n",
" compose_files=[\"./client-compose.yml\"],\n",
" compose_files=[\"./client/docker-compose.yml\"],\n",
")"
],
"id": "303433e5ea06bdd4",
Expand Down
17 changes: 13 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,28 @@
from setuptools import setup
from pathlib import Path

from setuptools import setup

this_directory: Path = Path(__file__).parent
long_description: str = (this_directory / "README.md").read_text()

setup(
name='autocode-py',
version='0.0.1.post2',
version='0.0.1.post6',
author='muazhari',
url='https://github.com/muazhari/autocode',
description='AutoCode: Automated Code Improvement by Metrics Optimization',
description='autocode: Auto Code Improvement by Metrics Optimization.',
long_description=long_description,
long_description_content_type='text/markdown',
packages=['autocode'],
license='MIT',
classifiers=[
'Intended Audience :: Developers',
'Operating System :: POSIX :: Linux',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Topic :: Software Development',
'Topic :: Scientific/Engineering',
],
install_requires=[
'pymoo',
'pydantic_settings',
Expand Down

0 comments on commit 41a39d2

Please sign in to comment.