Skip to content

Commit a0698aa

Browse files
Oleksii-KlimovOleksii-Klimov
committed
Initial commit.
0 parents  commit a0698aa

20 files changed

+1340
-0
lines changed

‎.dockerignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
**
2+
!poetry.lock
3+
!poetry.toml
4+
!pyproject.toml
5+
!entrypoint.sh
6+
!aidial_app_builder_python
7+
!templates

‎.flake8

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[flake8]
2+
# E501 string literal is too long
3+
# W503 line break before binary operator
4+
# E203 whitespace before ':' (triggered on list slices like xs[i : i + 5])
5+
ignore = E501, W503, E203
6+
exclude =
7+
.git,
8+
.venv,
9+
.nox,
10+
.pytest_cache,
11+
__pycache__,

‎CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# How to contribute
2+
3+
As an open-source project in a rapidly developing field, we are open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
4+
5+
For detailed information on how to contribute, see the full [contributing documentation](https://github.com/epam/ai-dial/blob/main/CONTRIBUTING.md).

‎Dockerfile

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
FROM python:3.11-alpine AS builder
2+
3+
ARG POETRY_VERSION=1.6.1
4+
5+
RUN pip install --upgrade pip
6+
RUN pip install poetry==$POETRY_VERSION
7+
8+
RUN echo "Poetry version:" && poetry --version
9+
10+
WORKDIR /builder
11+
12+
COPY pyproject.toml poetry.lock poetry.toml .
13+
RUN poetry install --no-interaction --no-ansi --only main
14+
15+
FROM python:3.11-alpine
16+
17+
ENV DIAL_BASE_URL=''
18+
ENV SOURCES=''
19+
ENV PROFILE=''
20+
ENV TARGET_DIR=/sources
21+
ENV TEMPLATES_DIR=/templates
22+
ENV API_KEY=''
23+
ENV JWT=''
24+
25+
RUN adduser -u 1001 --disabled-password --gecos "" appuser
26+
27+
WORKDIR /app
28+
29+
COPY --chown=appuser --from=builder /builder/.venv .venv
30+
COPY aidial_app_builder_python aidial_app_builder_python
31+
COPY templates templates
32+
COPY entrypoint.sh .
33+
RUN chmod +x entrypoint.sh
34+
35+
# Prepare "output" directories for code sources and docker image templates
36+
RUN mkdir ${TARGET_DIR} ${TEMPLATES_DIR} && \
37+
chown -R appuser:appuser ${TARGET_DIR} ${TEMPLATES_DIR}
38+
39+
ENV PYTHONUNBUFFERED=True
40+
ENV PATH=/app/.venv/bin:$PATH
41+
42+
USER appuser
43+
ENTRYPOINT ["/app/entrypoint.sh"]

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2023 EPAM Systems
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎Makefile

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
IMAGE_NAME ?= ai-dial-app-builder-python
2+
3+
.PHONY: all install build clean lint format
4+
5+
all: build
6+
7+
install:
8+
poetry install
9+
10+
build: install
11+
poetry build
12+
13+
clean:
14+
poetry env remove --all
15+
16+
lint: install
17+
poetry run nox -s lint
18+
19+
format: install
20+
poetry run nox -s format
21+
22+
help:
23+
@echo "===================="
24+
@echo "build - build the source and wheels archives"
25+
@echo "clean - clean virtual env and build artifacts"
26+
@echo "-- LINTING --"
27+
@echo "format - run code formatters"
28+
@echo "lint - run linters"

‎README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# AI-Dial App Builder Python
2+
3+
AI-Dial App Builder Python is a Python-based application designed to download source code from AI DIAL
4+
file storage and prepare files for an image builder (e.g., Docker, Kaniko) to build a container image.
5+
This tool is essential for automating the process of building and deploying Python applications.
6+
7+
8+
## Developer environment
9+
10+
This project uses [Python>=3.11](https://www.python.org/downloads/) and [Poetry>=1.6.1](https://python-poetry.org/) as a dependency manager.
11+
12+
Check out Poetry's [documentation on how to install it](https://python-poetry.org/docs/#installation) on your system before proceeding.
13+
14+
To install requirements:
15+
16+
```
17+
make install
18+
```
19+
20+
This will install all requirements for running the package, linting and formatting.
21+
22+
### Make on Windows
23+
24+
As of now, Windows distributions do not include the make tool. To run make commands, the tool can be installed using
25+
the following command (since [Windows 10](https://learn.microsoft.com/en-us/windows/package-manager/winget/)):
26+
27+
```sh
28+
winget install GnuWin32.Make
29+
```
30+
31+
For convenience, the tool folder can be added to the PATH environment variable as `C:\Program Files (x86)\GnuWin32\bin`.
32+
The command definitions inside Makefile should be cross-platform to keep the development environment setup simple.
33+
34+
35+
## Environment Variables
36+
37+
| Setting | Required | Description |
38+
|-----------------|----------|-------------------------------------------------|
39+
| `DIAL_BASE_URL` | Yes | The base URL for the DIAL service. |
40+
| `SOURCES` | Yes | The path to the source code in DIAL storage. |
41+
| `PROFILE` | Yes | The profile to use for building the image. |
42+
| `API_KEY` | No | API key for authentication with DIAL service. |
43+
| `JWT` | No | JWT token for authentication with DIAL service. |
44+
45+
46+
## Lint
47+
48+
Run the linting before committing:
49+
50+
```sh
51+
make lint
52+
```
53+
54+
To auto-fix formatting issues run:
55+
56+
```sh
57+
make format
58+
```
59+
60+
## Clean
61+
62+
To remove the virtual environment and build artifacts:
63+
64+
```sh
65+
make clean
66+
```
67+
68+
## License
69+
70+
This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.

‎aidial_app_builder_python/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)