update README.md for the Gradio branch
Browse files- README.md +13 -101
- runtime.txt +3 -0
README.md
CHANGED
|
@@ -1,101 +1,13 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
- Build system using `hatchling`
|
| 15 |
-
|
| 16 |
-
## Prerequisites
|
| 17 |
-
|
| 18 |
-
- Python 3.12 or higher
|
| 19 |
-
- `uv` package installer
|
| 20 |
-
|
| 21 |
-
## Installation
|
| 22 |
-
|
| 23 |
-
The only tool you need to install is `uv`. You can install it using `pip`:
|
| 24 |
-
|
| 25 |
-
```bash
|
| 26 |
-
pip install uv
|
| 27 |
-
```
|
| 28 |
-
|
| 29 |
-
`uv` is a modern Python package installer and resolver that offers several benefits over traditional pip. Benefits of using uv:
|
| 30 |
-
|
| 31 |
-
- Significantly faster installation and resolution of dependencies
|
| 32 |
-
- Built-in support for virtual environments
|
| 33 |
-
- Improved dependency resolution algorithm
|
| 34 |
-
- Written in Rust, offering better performance and memory safety
|
| 35 |
-
|
| 36 |
-
After `uv` is installed, prefix everything with `uv` or `uvx`:
|
| 37 |
-
- `uv pip install` for installing packages.
|
| 38 |
-
- `uvx` for running tools, like `uvx black`
|
| 39 |
-
|
| 40 |
-
## Development Workflow
|
| 41 |
-
|
| 42 |
-
1. Create and activate a virtual environment using `uv`:
|
| 43 |
-
```
|
| 44 |
-
uv venv
|
| 45 |
-
source .venv/bin/activate
|
| 46 |
-
```
|
| 47 |
-
|
| 48 |
-
2. Install the project and its dependencies:
|
| 49 |
-
```
|
| 50 |
-
make
|
| 51 |
-
```
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
### Code Formatting
|
| 55 |
-
|
| 56 |
-
We use `black` and `isort` to maintain consistent code formatting:
|
| 57 |
-
|
| 58 |
-
```
|
| 59 |
-
uvx isort src tests
|
| 60 |
-
uvx black src tests
|
| 61 |
-
```
|
| 62 |
-
|
| 63 |
-
### Linting and Type Checking
|
| 64 |
-
|
| 65 |
-
Run static type checking with `mypy`:
|
| 66 |
-
|
| 67 |
-
```
|
| 68 |
-
uv run mypy src
|
| 69 |
-
```
|
| 70 |
-
|
| 71 |
-
### Running Tests
|
| 72 |
-
|
| 73 |
-
Execute the test suite using `pytest`:
|
| 74 |
-
|
| 75 |
-
```
|
| 76 |
-
uv run pytest
|
| 77 |
-
```
|
| 78 |
-
|
| 79 |
-
### Building the Project
|
| 80 |
-
|
| 81 |
-
To build the project, use `hatchling`:
|
| 82 |
-
|
| 83 |
-
```
|
| 84 |
-
uvx hatchling build
|
| 85 |
-
```
|
| 86 |
-
|
| 87 |
-
## Configuration
|
| 88 |
-
|
| 89 |
-
Project configuration is managed through `pyproject.toml`. This includes settings for `black`, `isort`, `mypy`, and `pytest`.
|
| 90 |
-
|
| 91 |
-
## Makefile Commands
|
| 92 |
-
|
| 93 |
-
For convenience, common tasks are automated in the `Makefile`:
|
| 94 |
-
|
| 95 |
-
- `make install`: Install the project and its dependencies
|
| 96 |
-
- `make format`: Run code formatters
|
| 97 |
-
- `make lint`: Run linters and type checkers
|
| 98 |
-
- `make test`: Run the test suite
|
| 99 |
-
- `make build`: Build the project
|
| 100 |
-
|
| 101 |
-
Run `make help` to see all available commands.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: VSP data enrichment
|
| 3 |
+
emoji: 👀
|
| 4 |
+
colorFrom: green
|
| 5 |
+
colorTo: pink
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: 4.44.0
|
| 8 |
+
app_file: src/vsp/app/1st_gradio.py
|
| 9 |
+
pinned: false
|
| 10 |
+
license: apache-2.0
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
runtime.txt
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
sdk: gradio
|
| 2 |
+
app_file: src/vsp/app/1st_gradio.py
|
| 3 |
+
|