Skip to content

Commit 852c934

Browse files
committed
docs: update readme
1 parent b688dd7 commit 852c934

2 files changed

Lines changed: 37 additions & 25 deletions

File tree

.github/workflows/publish.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,22 @@ jobs:
4545
- name: Publish to PyPI
4646
uses: pypa/gh-action-pypi-publish@release/v1
4747

48-
publish-to-testpypi:
49-
name: Publish to TestPyPI (optional)
50-
needs: build
51-
runs-on: ubuntu-latest
52-
environment:
53-
name: testpypi
54-
url: https://test.pypi.org/p/vibepython
55-
permissions:
56-
id-token: write
57-
steps:
58-
- name: Download distributions
59-
uses: actions/download-artifact@v4
60-
with:
61-
name: python-package-distributions
62-
path: dist/
63-
- name: Publish to TestPyPI
64-
uses: pypa/gh-action-pypi-publish@release/v1
65-
with:
66-
repository-url: https://test.pypi.org/legacy/
48+
# publish-to-testpypi:
49+
# name: Publish to TestPyPI (optional)
50+
# needs: build
51+
# runs-on: ubuntu-latest
52+
# environment:
53+
# name: testpypi
54+
# url: https://test.pypi.org/p/vibepython
55+
# permissions:
56+
# id-token: write
57+
# steps:
58+
# - name: Download distributions
59+
# uses: actions/download-artifact@v4
60+
# with:
61+
# name: python-package-distributions
62+
# path: dist/
63+
# - name: Publish to TestPyPI
64+
# uses: pypa/gh-action-pypi-publish@release/v1
65+
# with:
66+
# repository-url: https://test.pypi.org/legacy/

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🚀 **Python AI Console: The Ultimate AI-Powered Coding EXPLOSION!** 🌟💥🐍
1+
# 🚀 **Python Console: The Ultimate AI-Powered Coding EXPLOSION!** 🌟💥🐍
22

33
**WOWZA!** Dive headfirst into this **AMAZING**, **WONDERFUL**, **MIND-BLOWING** interactive command-line beast that turns your craziest prompts into **EXECUTABLE PYTHON MAGIC** using the sheer power of OpenAI! Generate code like a wizard, run it on the spot, capture every wild stdout/stderr outburst, and keep a super-smart history in JSON for non-stop contextual awesomeness! It's not just a tool – it's a **CODE REVOLUTION** for hackers, dreamers, and AI fanatics! 🔥🚀
44

@@ -12,14 +12,26 @@
1212

1313
## 🛠️ **Installation: Get This Party Started in SECONDS!** 🚀
1414

15+
### **From PyPI: Pip It Like It's HOT – Instant VIBE!** 🔥💥
16+
1. **GRAB THE PACKAGE**:
17+
```
18+
pip install vibepython
19+
```
20+
2. **FIRE IT UP**:
21+
```
22+
vibepython
23+
```
24+
- **Pro Tip**: Don't forget to set your `OPENAI_API_KEY` env var for AI magic! 🔑 (e.g., `export OPENAI_API_KEY=your_key_here`).
25+
**VIBE ACTIVATED! Dive into the AI console vibe!** 🚀
26+
1527
### **From Source: Clone, Install, BLAST OFF!** 🌌
1628
1. **CLONE THE AWESOMENESS**:
1729
```
18-
git clone https://github.com/OldTyT/python-ai-console.git
30+
git clone https://github.com/OldTyT/vibepython.git
1931
```
2032
2. **JUMP IN**:
2133
```
22-
cd python-ai-console
34+
cd vibepython
2335
```
2436
3. **INSTALL THE MAGIC**:
2537
```
@@ -31,18 +43,18 @@
3143
```
3244
**BOOM! You're in the zone!** 💣
3345

34-
### **Using Docker: Containerized CHAOS – Ready to RUMBLE!** 🐳🔥
46+
### **Using Docker: Containerized VIBE – Ready to RUMBLE!** 🐳🔥
3547
Fire it up with this epic command:
3648
```
37-
docker run --rm -ti -e HISTORY_PATH=/history/history.json -e OPENAI_API_KEY=YOUR_KEY -v my_history:/history ghcr.io/oldtyt/autopost-python-ai-console
49+
docker run --rm -ti -e HISTORY_PATH=/history/history.json -e OPENAI_API_KEY=YOUR_KEY -v my_history:/history ghcr.io/oldtyt/vibepython
3850
```
3951
- Plug in `YOUR_KEY` with your OpenAI super-key! 🔑
4052
**DOCKER DELIGHT: Persistent history, zero hassle!** 🌟
4153

4254
## 🎮 **Usage: Dive into the FUN ZONE!** 🕹️
4355
Fire it up and get prompted:
4456
- **SMASH IN A PROMPT** (e.g., "Code me a factorial frenzy!").
45-
- **AI UNLEASHES CODE CHAOS** based on your prompt + history vibes.
57+
- **AI UNLEASHES CODE VIBE** based on your prompt + history vibes.
4658
- **EXECUTE? Y/N – YOU DECIDE!** Run it, capture outputs, and watch the sparks fly! ⚡
4759
- **HISTORY SAVES THE DAY**: Everything logged for eternal glory.
4860

0 commit comments

Comments
 (0)