aviol commited on
Commit
4305d15
Β·
1 Parent(s): d51321a

Fixed README

Browse files
Files changed (1) hide show
  1. README.md +33 -96
README.md CHANGED
@@ -1,111 +1,48 @@
1
- # Uvify UI
 
 
 
 
 
 
 
 
2
 
3
- A modern web interface for [uvify](https://github.com/avilum/uvify) - Turn Python repositories into uv environment oneliners.
4
 
5
- ## Features
6
-
7
- - πŸš€ Analyze GitHub repositories and local directories
8
- - πŸ“¦ Parse dependencies from requirements.txt, pyproject.toml, and setup.py
9
- - 🎯 Generate ready-to-use `uv` commands
10
- - πŸ“‹ Copy commands and download results as JSON
11
- - 🎨 Beautiful, GitIngest-inspired UI
12
-
13
- ## Quick Start
14
-
15
- ### Prerequisites
16
-
17
- - Node.js 18+
18
- - Python 3.8+
19
- - [uv](https://github.com/astral-sh/uv) package manager
20
-
21
- Install uv if you haven't already:
22
- ```bash
23
- curl -LsSf https://astral.sh/uv/install.sh | sh
24
- # or on macOS:
25
- brew install uv
26
- ```
27
-
28
- ### Installation & Running
29
-
30
- The easiest way to run both the UI and API servers:
31
-
32
- ```bash
33
- npm start
34
- ```
35
 
36
- This will:
37
- 1. Install all dependencies (if needed)
38
- 2. Start the uvify API server on http://localhost:8000
39
- 3. Start the UI development server on http://localhost:5173
40
-
41
- ### Manual Setup
42
-
43
- If you prefer to run the servers separately:
44
-
45
- 1. Install dependencies:
46
- ```bash
47
- npm install
48
- uv venv
49
- source .venv/bin/activate
50
- uv pip install 'uvify[api]'
51
- ```
52
-
53
- 2. Start the API server:
54
- ```bash
55
- npm run start:api
56
- ```
57
-
58
- 3. In another terminal, start the UI:
59
- ```bash
60
- npm run start:ui
61
- ```
62
-
63
- ## Usage
64
-
65
- 1. Enter a GitHub repository URL or username/repo format
66
- 2. Click "Analyze" to process the repository
67
- 3. View the results showing:
68
- - Parsed dependencies per file
69
- - Ready-to-use `uv` commands
70
- - Python version requirements
71
- - Directory structure
72
-
73
- ## Development
74
 
75
- ### Project Structure
 
 
 
76
 
77
- ```
78
- uvifyUI/
79
- β”œβ”€β”€ src/
80
- β”‚ β”œβ”€β”€ components/ # React components
81
- β”‚ β”œβ”€β”€ services/ # API integration
82
- β”‚ └── types/ # TypeScript types
83
- β”œβ”€β”€ public/ # Static assets
84
- └── start.sh # Unified start script
85
- ```
86
 
87
- ### Available Scripts
 
 
 
88
 
89
- - `npm start` - Run both UI and API servers
90
- - `npm run dev` - Run UI development server only
91
- - `npm run build` - Build for production
92
- - `npm run lint` - Run ESLint
93
 
94
- ## Environment Variables
 
95
 
96
- Copy `.env.example` to `.env` and configure:
97
 
98
- ```
99
- VITE_API_URL=http://localhost:8000
100
- ```
101
 
102
  ## Built With
103
 
104
- - React + TypeScript
105
- - Vite
106
- - Tailwind CSS
107
- - uvify API backend
108
 
109
- ## License
110
 
111
- This project is built on top of uvify. See the [uvify repository](https://github.com/avilum/uvify) for license information.
 
1
+ ---
2
+ title: Uvify
3
+ emoji: πŸ“¦
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: docker
7
+ pinned: false
8
+ license: mit
9
+ ---
10
 
11
+ # Uvify - UV Package Manager Helper
12
 
13
+ Uvify analyzes GitHub repositories and generates the optimal `uv` commands to install them with their dependencies.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
 
15
+ ## Features
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
+ ✨ **Smart Repository Analysis** - Automatically detects project structure and dependencies
18
+ πŸš€ **UV Command Generation** - Creates optimized `uv` installation commands
19
+ 🎯 **Multiple Project Support** - Handles various Python project types
20
+ πŸ”§ **Dependency Resolution** - Finds and lists all required dependencies
21
 
22
+ ## How to Use
 
 
 
 
 
 
 
 
23
 
24
+ 1. Enter a GitHub repository URL or `owner/repo` format
25
+ 2. Click "Analyze Repository"
26
+ 3. Get the optimized `uv` command and dependency list
27
+ 4. Copy and run the command in your terminal
28
 
29
+ ## Example
 
 
 
30
 
31
+ Input: `psf/requests`
32
+ Output: `uv run --with 'git+https://github.com/psf/requests' --python '3.11' python`
33
 
34
+ ## API
35
 
36
+ This Space also provides a REST API:
37
+ - **GET** `/api/{owner}/{repo}` - Analyze a repository
38
+ - **GET** `/api/docs` - API documentation
39
 
40
  ## Built With
41
 
42
+ - **Frontend**: React + TypeScript + Tailwind CSS
43
+ - **Backend**: FastAPI + uvify package
44
+ - **Deployment**: Docker on HuggingFace Spaces
 
45
 
46
+ ---
47
 
48
+ *Made with ❀️ for the Python community*