Initial commit
- Python package to fetch song lyrics from paroles.net - Web scraping functionality with requests and BeautifulSoup4 - Command-line interface for easy usage - Comprehensive test suite with pytest - GitLab CI configuration with uv support - Package metadata and dependencies in pyproject.toml - Documentation and usage instructions
This commit is contained in:
+68
@@ -0,0 +1,68 @@
|
||||
# Using uv with paroles-net-scraper
|
||||
|
||||
This document explains how to use uv with the paroles-net-scraper package.
|
||||
|
||||
## Installation with uv
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd paroles-net-scraper
|
||||
```
|
||||
|
||||
2. Install dependencies with uv:
|
||||
```bash
|
||||
uv sync
|
||||
```
|
||||
|
||||
## Running the package with uv
|
||||
|
||||
After installing dependencies, you can run the package directly with uv:
|
||||
|
||||
```bash
|
||||
uv run paroles-scraper "Artist Name" "Song Title"
|
||||
```
|
||||
|
||||
## Running tests with uv
|
||||
|
||||
To run the test suite with uv:
|
||||
|
||||
```bash
|
||||
uv run pytest tests/ -v
|
||||
```
|
||||
|
||||
## Building the package with uv
|
||||
|
||||
To build the package distribution files:
|
||||
|
||||
```bash
|
||||
uv build
|
||||
```
|
||||
|
||||
This will create both source and wheel distributions in the `dist/` directory.
|
||||
|
||||
## Installing the package in development mode with uv
|
||||
|
||||
```bash
|
||||
uv pip install -e .
|
||||
```
|
||||
|
||||
## Managing dependencies with uv
|
||||
|
||||
To add a new dependency:
|
||||
|
||||
```bash
|
||||
uv add <package-name>
|
||||
```
|
||||
|
||||
To remove a dependency:
|
||||
|
||||
```bash
|
||||
uv remove <package-name>
|
||||
```
|
||||
|
||||
To update dependencies:
|
||||
|
||||
```bash
|
||||
uv lock --upgrade
|
||||
```
|
||||
Reference in New Issue
Block a user