Skip to content

Add docker setup #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BytecodeBrewer merged 5 commits into from
Jun 25, 2026
Merged

Add docker setup #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc6c7cf
docs(#41): add dockerfile
BytecodeBrewer Jun 25, 2026
549ffaf
docs(#41): add dockerignore
BytecodeBrewer Jun 25, 2026
6e921cb
docs(#41): fix dockerignore
BytecodeBrewer Jun 25, 2026
0060945
docs(#41): update readme
BytecodeBrewer Jun 25, 2026
e1d4b65
docs(#41): improve readme
BytecodeBrewer Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .dockerignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Git
.git
.github
.githooks
.gitignore

# Local environment and secrets
.venv
.env

# Python cache and test cache
__pycache__
.pytest_cache
.ruff_cache
.mypy_cache
.coverage
htmlcov

# Build artifacts
dist
build
*.egg-info

# Project docs not needed for the test image
docs
31 changes: 21 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ README.md
- Tkinter
- pytest

### Current data source
### Current data sources

- ExchangeRate API for live currency conversion
- yfinance for historical market-data retrieval and analytics
Expand All @@ -140,8 +140,6 @@ Planned or likely future technologies include:

### Data processing

- pandas
- NumPy
- possibly Polars later for larger datasets

### Storage
Expand All @@ -153,14 +151,10 @@ Planned or likely future technologies include:

### Visualization and UI

- matplotlib
- Plotly
- NiceGUI

### DevOps and deployment

- GitHub Actions
- Docker
- Docker Compose
- cloud deployment later

Expand Down Expand Up @@ -199,6 +193,7 @@ Recommended for development:
- VS Code
- a virtual environment
- pytest
- Docker, if you want to run tests in an isolated container environment

> [!NOTE]
> Runtime dependencies are managed through `pyproject.toml`.
Expand Down Expand Up @@ -254,7 +249,7 @@ pip install -e ".[dev]"

## API Key Setup

ARGUS currently uses the ExchangeRate API for live currency conversion.
ARGUS uses the ExchangeRate API for live currency conversion. Historical analytics currently use yfinance and do not require an additional API key.

### 1. Create an API key

Expand Down Expand Up @@ -284,7 +279,7 @@ The `.env` file must stay local and should never be committed.

---

## Running ARGUS
## Running ARGUS Locally

Start the current Tkinter GUI:

Expand All @@ -294,6 +289,22 @@ python -m argus.main

This starts the local ARGUS prototype with calculator, currency conversion and basic analytics views.

## Running Argus in Docker

ARGUS includes a minimal Docker setup for running the test suite in an isolated container environment.

Build the Docker image:

```bash
docker build -t argus .

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Rename the Dockerfile to match Docker defaults

With the build file committed as lowercase dockerfile, the documented docker build -t argus . command here will not find it on case-sensitive filesystems such as Linux CI; Docker's default build path is a file literally named Dockerfile unless -f is supplied. Rename the file to Dockerfile or change this command to docker build -f dockerfile -t argus . so the new Docker setup works as documented.

Useful? React with 👍 / 👎.

```

Run ARGUS in a container:

```bash
docker run --rm argus
```

### Legacy CLI / Debug Interface

The legacy CLI is still available for quick local checks and debugging:
Expand All @@ -310,7 +321,7 @@ python src/legacy/debug_main.py

## Running Tests

Run the test suite:
Run the test suite locally:

```bash
pytest
Expand Down
12 changes: 12 additions & 0 deletions dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
FROM python:3.11-slim

WORKDIR /app

COPY pyproject.toml README.md ./
COPY src/ ./src/
COPY tests/ ./tests/

RUN python -m pip install --upgrade pip \
&& pip install -e ".[dev]"

CMD ["pytest"]
Loading