Skip to main content

Easily define your own software project idea and then build entirely by just clicking a button.

Project description

Just Ralph It (a.k.a. Ralfealo)

Overview

Just Ralph It is a software system that aims to help you easily define your software project idea and then build entirely by just clicking a button. To know more about it, read the concept document.

Feature Roadmap

  • Terminal UI
  • Interviewer
    • Exploration
    • Note taking
    • Topic-based context management
  • Project implementation
  • Remote execution
  • Web UI
    • Notes graph visualization
  • Hosted platform

Getting Started

0. Prerrequisites

  • Python >=3.13 or uv
  • API key from any OpenAI-compatible LLM inference provider or a ChatGPT subscription

1. Installation

pip install just-ralph-it
# or
uv tool install just-ralph-it

2. Authentication

You can create a .env file at the root of your project or home directory. You can also export the variables in your shell or pass them as CLI arguments (see jri --help).

Using an API key

# .env

# To use OpenAI as the provider, just set your OpenAI key here
JRI_LLM_API_KEY=...

# To use any OpenAI-compatible provider, provide its base URL too
JRI_LLM_PROVIDER=https://provider.example/v1
JRI_LLM_API_KEY=...

Using a ChatGPT subscription

For this, you need to have Codex installed and configure it to store credentials in a file:

# ~/.codex/config.toml
cli_auth_credentials_store = "file"

Then run:

codex login

Finally, configure it as the provider:

# .env

JRI_LLM_PROVIDER=openai-codex

Optional: Brave Search

To support web search, provide a Brave Search API key:

# .env

JRI_BRAVE_SEARCH_API_KEY=...

3. Usage

# Run the TUI and start chatting!
jri

# Visualize the notes graph
jri view

[!TIP] Given that JRI doesn't feature project implementation yet, you can hand the generated .jri/graph.json file to your favorite coding agent as a starting point for implementation.

Upgrading

python -m pip install --upgrade just-ralph-it
# or
uv tool upgrade just-ralph-it

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

Uninstalling

# Uninstall JRI and its dependencies
pip uninstall just-ralph-it
# or
uv tool uninstall just-ralph-it

# Remove JRI from a repo
rm -fr /path/to/your-project/.jri

Contributing

Please refer to AGENTS.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

just_ralph_it-0.3.1.tar.gz (36.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

just_ralph_it-0.3.1-py3-none-any.whl (47.3 kB view details)

Uploaded Python 3

File details

Details for the file just_ralph_it-0.3.1.tar.gz.

File metadata

  • Download URL: just_ralph_it-0.3.1.tar.gz
  • Upload date:
  • Size: 36.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for just_ralph_it-0.3.1.tar.gz
Algorithm Hash digest
SHA256 565aab1bc37ddb94606db3be51abf4c90e3b3cf31803d73d6ced956c22418c9e
MD5 abab4f5ff6654481300cc0720dd419b7
BLAKE2b-256 f4ae4e22697eb3f0c3f41a032a6747b74e1a57d01d8d3d753bb428fb8ced7087

See more details on using hashes here.

File details

Details for the file just_ralph_it-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: just_ralph_it-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 47.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for just_ralph_it-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 00d6daf2ba41150597682d635fa5440eae4ff3db0beaaccc33468bbc5647bb64
MD5 95553e49052904b0084e8b7f1f34c4a5
BLAKE2b-256 3fa136a9c98ef78e910f5317eab13b2f5f6dc7519fcfe984b65a4770c7851b38

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page