PodFetch | README

> More changes
This commit is contained in:
Eugene Amos 2023-08-08 20:32:56 -07:00
parent fdb9eaf003
commit 8dacd7930e

View File

@ -1,6 +1,17 @@
<link href="file:///assets/escripts.css" rel="stylesheet">
<style>
details > summary {
padding: 10px;
width: 200px;
background-color: #333;
border: none;
box-shadow: 1px 1px 2px #bbbbbb;
cursor: pointer;
font-size: 20px;
font-weight: bold;
}
</style>
<a name="top"></a>
<a name="readme-top"></a>
<h1 align="center">PodFetch Folder Monitor</h1>
@ -15,12 +26,29 @@
## Table of Contents
[01. PIP](#01-pip)
[02. Folder Structure](#02-folder-structure)
[03. Script](#03-script)
[04. Run](#04-run)
[05. Testing](#05-testing)
[06. Automation](#06-automation)
<details>
<summary>Table of Contents</summary>
<ol>
<li><a href="#01-pip">PIP</a></li>
<li><a href="#02-folder-structure">Getting Started</a></li>
<li><a href="#03-script">Script</a></li>
<li><a href="#04-run">Run</a></li>
<li><a href="#05-testing">Testing</a></li>
<li><a href="#06-automation">Automation</a></li>
</ol>
</details>
## 01. PIP
You will need pip installed on your linux mint system. **<a href="https://pypi.org/project/pip/" target="_blank">PIP</a>** is the package manager for Python.
@ -45,6 +73,8 @@ Create a new folder called **scripts** in your home folder. This is where all yo
When done it should look like this: `/home/[username]/scripts`
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 03. Script
```python
@ -102,6 +132,8 @@ Save this script as `podcast_folder_monitor.py` in the scripts folder. Next we n
* Check the `Execute` box to allow executing the file as a program.
* Close out the window.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 04. Run
Now we need to test and run the script.
@ -120,6 +152,8 @@ You should now see the blinking curser in the terminal indicating that the scrip
![testing](img/running_podcast.png)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 05. Testing
To test the script copy and paste one of your podcast folder that includes the podcast.mp3 file back into the folder. The script should notice the change and rename the **.mp3** to the name of the parent folder.
@ -128,6 +162,8 @@ To test the script copy and paste one of your podcast folder that includes the p
If everything worked out okay we can move to the next step.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 06. Automation
We can make the script auto run in the background. Just like Sonarr, Radarr, etc...
@ -176,4 +212,6 @@ sudo systemctl status podfetch
### Congratulation your service is auto-running and listing for new podcast folders.
<a class="top-link hide" href="#top"></a>
<a class="top-link hide" href="#top"></a>
<p align="right">(<a href="#readme-top">back to top </a>)</p>