-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
402 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
ENV=dev |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# **AtlasML** | ||
|
||
A lightweight FastAPI application template that supports **Conda** for environment management and **Poetry** for dependency management. This app provides a basic health check endpoint and is ready for development and testing. | ||
|
||
--- | ||
|
||
## **Features** | ||
- FastAPI framework for building APIs. | ||
- Poetry for modern Python dependency management. | ||
- Conda environment for isolating Python runtime and libraries. | ||
- Pre-configured endpoints: | ||
- `/` - Home route. | ||
- `/health` - Health check. | ||
|
||
--- | ||
|
||
## **Setup Instructions** | ||
|
||
### 1. **Clone the Repository** | ||
```bash | ||
git clone <repository_url> | ||
cd AtlasML | ||
``` | ||
|
||
### 2. Setup Environment | ||
1. Ensure you have [Conda](https://docs.anaconda.com/miniconda/install/#quick-command-line-install) and [Poetry](https://python-poetry.org/docs/#installation) installed on your system. | ||
|
||
2. Install the dependencies: | ||
```bash | ||
poetry install | ||
``` | ||
|
||
3. Activate the Virtual Environment: | ||
```bash | ||
poetry shell | ||
``` | ||
|
||
4. Run the Application: | ||
``` bash | ||
poetry run uvicorn atlasml.app:app --reload | ||
``` | ||
|
||
OR | ||
|
||
3. Run the Application with Poetry: | ||
```bash | ||
poetry run uvicorn atlasml.app:app --reload | ||
``` | ||
|
||
## Development | ||
|
||
|
||
## Environment Variables | ||
Please create a `.env` file in the root directory and add the the environment variables according to the `.env.example` file. If you add new environment variables, please update the `.env.example` file. | ||
|
||
## License |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
from fastapi import FastAPI | ||
import os | ||
|
||
ENV = os.getenv("ENV", "dev") | ||
|
||
app = FastAPI() | ||
|
||
@app.get("/") | ||
def index(): | ||
return {"message": f"HELLO {ENV}"} | ||
|
||
@app.get("/health") | ||
def health(): | ||
return {"status": "ok"} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
[tool.poetry] | ||
name = "atlasml" | ||
version = "0.1.0" | ||
description = "" | ||
authors = ["ufukygmr <[email protected]>"] | ||
readme = "README.md" | ||
|
||
[tool.poetry.dependencies] | ||
python = "^3.13" | ||
fastapi = "^0.115.5" | ||
|
||
|
||
[tool.poetry.group.dev.dependencies] | ||
uvicorn = "^0.32.1" | ||
|
||
[build-system] | ||
requires = ["poetry-core"] | ||
build-backend = "poetry.core.masonry.api" |
Empty file.