Metadata-Version: 2.4
Name: just-ralph-it
Version: 0.6.0
Summary: Think through a software project idea, then build it with one click.
Author: Nicolás Pujia
Author-email: Nicolás Pujia <contact@nicolaspujia.com>
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Requires-Dist: httpx>=0.28.1
Requires-Dist: markdownify>=1.2.3
Requires-Dist: openai>=2.41.0
Requires-Dist: python-dotenv>=1.2.2
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: textual>=8.2.7
Requires-Dist: youtube-transcript-api>=1.2.4
Requires-Python: >=3.13
Project-URL: Homepage, https://justralph.it
Project-URL: Repository, https://github.com/nicopujia/just-ralph-it
Project-URL: Issues, https://github.com/nicopujia/just-ralph-it/issues
Description-Content-Type: text/markdown

# [Just Ralph It](https://justralph.it) (a.k.a. _[Ralfealo](https://ralfealo.com)_)

## Overview

Just Ralph It (JRI) is a software that helps you think through your software project idea, and then to build it with one click. You just have to share your thoughts, and JRI handles the rest.

> [!NOTE]
> To know more about this project vision and motivation, read the [concept document](https://nicolaspujia.com/just-ralph-it).

### Feature Roadmap

- [x] Terminal UI
- [x] Requirements gathering interview
  - [x] Exploration
    - [x] Local shell commands
    - [x] Local files, including images
    - [x] Web search
    - [x] Public URLs, including YouTube videos
  - [x] Note taking
  - [x] Topic-based context management
- [ ] Automated implementation (inspired on the [SDLC](https://en.wikipedia.org/wiki/Systems_development_life_cycle) and the [Ralph technique](https://ghuntley.com/ralph/))
  - [x] Requirements analysis
  - [x] System design
  - [ ] Development
  - [ ] Quality assurance
  - [ ] Deployment
  - [ ] Maintenance
- [ ] Remote execution
- [ ] Web UI
  - [x] Notes graph visualization
- [ ] Hosted platform

## Getting Started

### 0. Prerequisites

- [Python](https://www.python.org/downloads/) >=3.13 or [uv](https://docs.astral.sh/uv/getting-started/installation/)
- API key from any [OpenAI-compatible](https://github.com/openai/openai-python) LLM inference provider OR a [ChatGPT](https://chatgpt.com/codex/pricing/) subscription
- [Git](https://git-scm.com/install/) >=2.x.x

### 1. Installation

```bash
uv tool install just-ralph-it
# Alternative command:
pip install just-ralph-it
```

### 2. Setup

Move to a project directory and set it up:

```bash
mkdir ./my-project
cd ./my-project
jri init
```

That creates `.jri/config.yaml`. Open it and follow its comments.

### 3. Usage

```bash
# Run the TUI to start a chat session:
jri chat

# Show the notes graph:
jri view
```

> [!TIP]
> Given that there isn't automated implementation yet, you can hand the generated `.jri/notebook.yaml` or `.jri/specs/` to your favorite coding agent as a starting point for implementation.

## Upgrading

```bash
uv tool upgrade just-ralph-it
# Alternative command:
pip install --upgrade just-ralph-it
```

> [!WARNING]
> Until reaching a stable version (>=1.0.0), anything could break from one version to another.

## Uninstalling

```bash
uv tool uninstall just-ralph-it
# Alternative command:
pip uninstall just-ralph-it

# Remove JRI from the project:
rm -fr /path/to/your-project/.jri
```
