Initial commit
This commit is contained in:
commit
e86ab53de5
35 changed files with 2638 additions and 0 deletions
83
README.md
Normal file
83
README.md
Normal file
|
@ -0,0 +1,83 @@
|
|||
# Podcastrr
|
||||
|
||||
A podcast management application similar to Sonarr but for podcasts, built with Python and Flask.
|
||||
|
||||
## Features
|
||||
|
||||
- **Search for Podcasts**: Find podcasts from various sources
|
||||
- **Track Podcasts**: Monitor your favorite podcasts for new episodes
|
||||
- **Download Management**: Automatically download new episodes and manage storage
|
||||
- **Custom Naming**: Configure how downloaded files are named
|
||||
- **Web Interface**: Manage everything through an intuitive web interface
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.8+
|
||||
- Dependencies listed in `requirements.txt`
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/yourusername/podcastrr.git
|
||||
cd podcastrr
|
||||
```
|
||||
|
||||
2. Create and activate a virtual environment:
|
||||
```
|
||||
python -m venv .venv
|
||||
# On Windows
|
||||
.venv\Scripts\activate
|
||||
# On macOS/Linux
|
||||
source .venv/bin/activate
|
||||
```
|
||||
|
||||
3. Install dependencies:
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
4. Create a `.env` file in the root directory with the following variables:
|
||||
```
|
||||
FLASK_ENV=development
|
||||
SECRET_KEY=your_secret_key
|
||||
DATABASE_URI=sqlite:///podcastrr.db
|
||||
DOWNLOAD_PATH=/path/to/downloads
|
||||
```
|
||||
|
||||
5. Initialize the database:
|
||||
```
|
||||
flask db init
|
||||
flask db migrate
|
||||
flask db upgrade
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Run the application:
|
||||
```
|
||||
python main.py
|
||||
```
|
||||
|
||||
Then open your browser and navigate to `http://localhost:5000`.
|
||||
|
||||
## Development
|
||||
|
||||
1. Install development dependencies:
|
||||
```
|
||||
pip install -r requirements-dev.txt
|
||||
```
|
||||
|
||||
2. Run tests:
|
||||
```
|
||||
pytest
|
||||
```
|
||||
|
||||
3. Format code:
|
||||
```
|
||||
black .
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
Loading…
Add table
Add a link
Reference in a new issue