euronvault/escripts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update 'podfetch/README.md'

Browse Source 
updating podfetch README
This commit is contained in:
Eugene Amos 2023-08-08 22:11:23 -07:00
parent 1be2c2928e
commit 89dec28645
1 changed files with 17 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
podfetch/README.md
View File

@ -1,17 +1,3 @@
<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="readme-top"></a>
<h1 align="center">PodFetch Folder Monitor</h1> <h1 align="center">PodFetch Folder Monitor</h1>
@ -23,16 +9,7 @@ details > summary {
<br /> <br />
</p> </p>
## Table of Contents <details open>
[01. PIP](#01-pip) <br>
[02. Folder Structure](#02-folder-structure) <br>
[03. Script](#03-script) <br>
[04. Run](#04-run) <br>
[05. Testing](#05-testing) <br>
[06. Automation](#06-automation) <br>
<details>
<summary>Table of Contents</summary> <summary>Table of Contents</summary>
<ol> <ol>
<li><a href="#01-pip">PIP</a></li> <li><a href="#01-pip">PIP</a></li>
@ -51,7 +28,7 @@ You will need pip installed on your linux mint system. **<a href="https://pypi.o
* See if PIP is already installed. Open a terminal and type: * See if PIP is already installed. Open a terminal and type:
`pip -V` `pip -V`
* If not, install it. * If not, install it.
`python get-pip.py` `python get-pip.py`
* Once installed, install watchdog * Once installed, install watchdog
@ -68,10 +45,13 @@ 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` When done it should look like this: `/home/[username]/scripts`
<p align="right">(<a href="#readme-top">back to top</a>)</p> [🔼 Back to top](#top)
## 03. Script ## 03. Script
<details>
<summary>podcast_folder_monitor.py</summary>
```python ```python
#!/usr/bin/python3 #!/usr/bin/python3
@ -115,7 +95,9 @@ if __name__ == "__main__":
observer.join() observer.join()
``` ```
Make sure to replace `/some/folder/to/monitor` with the actual path of the folder you want to monitor. </details>
Make sure to replace `/some/folder/to/monitor` with the actual path of the folder you want to monitor.
> **Note:** leave the quotation marks > **Note:** leave the quotation marks
@ -127,15 +109,15 @@ 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. * Check the `Execute` box to allow executing the file as a program.
* Close out the window. * Close out the window.
<p align="right">(<a href="#readme-top">back to top</a>)</p> [🔼 Back to top](#top)
## 04. Run ## 04. Run
Now we need to test and run the script. Now we need to test and run the script.
Make sure you terminal is open to the location of the `podcast_folder_monitor.py` file. Should be `~/scripts` Make sure you terminal is open to the location of the `podcast_folder_monitor.py` file. Should be `~/scripts`
Normally to run a Python script will would use Normally to run a Python script will would use
`python3 podcast_folder_monitor.py` `python3 podcast_folder_monitor.py`
> **Note:** Will still work. > **Note:** Will still work.
@ -147,7 +129,7 @@ You should now see the blinking curser in the terminal indicating that the scrip
![testing](img/running_podcast.png) ![testing](img/running_podcast.png)
<p align="right">(<a href="#readme-top">back to top</a>)</p> [🔼 Back to top](#top)
## 05. Testing ## 05. Testing
@ -157,7 +139,7 @@ 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. If everything worked out okay we can move to the next step.
<p align="right">(<a href="#readme-top">back to top</a>)</p> [🔼 Back to top](#top)
## 06. Automation ## 06. Automation
@ -166,7 +148,7 @@ We can make the script auto run in the background. Just like Sonarr, Radarr, etc
To get started we need to crate a new file in the systemd location. To get started we need to crate a new file in the systemd location.
* Go to `/etc/systemd/system` * Go to `/etc/systemd/system`
* Right click in a empty space and select `Open as Root`. Root access is needed to create or edit in this directory. * Right click in a empty space and select `Open as Root`. Root access is needed to create or edit in this directory.
* Create a new file called `podfetch.service` * Create a new file called `podfetch.service`
* Use this code inside the `podfetch.service` file. * Use this code inside the `podfetch.service` file.
@ -205,8 +187,6 @@ sudo systemctl start podfetch
sudo systemctl status podfetch sudo systemctl status podfetch
``` ```
### Congratulation your service is auto-running and listing for new podcast folders. ### Congratulation your service is auto-running and listing for new podcast folders
<a class="top-link hide" href="#top">↑</a> [🔼 Back to top](#top)
<p align="right">(<a href="#readme-top">back to top </a>)</p>