Skip to content

Commit

Permalink
Fixed issues with Cocker on ARM & Linux, Fixed issues in the readme, …
Browse files Browse the repository at this point in the history
…Bumped to 0.7.1

Update Dockerfile, readme.md, and __version__.py
  • Loading branch information
aziascreations committed Feb 28, 2022
1 parent 3c55ee3 commit 4556b25
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 14 deletions.
9 changes: 5 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ ARG BGID=1000

# Installing dependencies.
# * 'g++', 'make' -> Compiling some dependencies.
# * 'libxslt-dev', 'libxml2-dev' -> Compiling some dependencies (ARM only, apparently).
# * 'py3-lxml' -> Pre-compiled module, allows you to ignore compilation errors.
RUN apk update && apk upgrade && \
apk add --no-cache g++ make py3-lxml ffmpeg
apk add --no-cache g++ make py3-lxml ffmpeg libxslt-dev libxml2-dev

# Previously used to compile lxml for streamlink. (Not used for the moment)
# RUN apk add --no-cache libxslt-dev libxml2-dev
# RUN apk add --no-cache

# Installing required Python packages.
ADD --chown=BUID:BGID ./requirements.txt /app/requirements.txt
ADD --chown=$BUID:$BGID ./requirements.txt /app/requirements.txt
RUN pip install --upgrade -r /app/requirements.txt

# Removing packages that are no longer needed and were used for compiling streamlink and its dependencies.
Expand All @@ -26,7 +27,7 @@ RUN pip install --upgrade -r /app/requirements.txt
RUN apk del g++ make

# Copying the app's files to the container
ADD --chown=BUID:BGID . /app
ADD --chown=$BUID:$BGID . /app

# Running the application.
# * Thanks to jdpus for the "-u" flag, it fixes the output (https://stackoverflow.com/a/29745541/4135541)
Expand Down
15 changes: 6 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Youtube Auto Archiver <sub><sup>v0.7.0</sup></sub>
# Youtube Auto Archiver <sub><sup>v0.7.1</sup></sub>
A simple and yet highly configurable Python application that automatically checks if a Youtuber is streaming,
and downloads said streams while also archiving its latest uploads.

Expand Down Expand Up @@ -28,7 +28,7 @@ The application isn't designed to be used by another one as a module.
* Native support for cookies for *yt-dlp* and maybe *streamlink*.
* Better support to prevent command injection. (Will block some features if used)
* Planned for later
* Using TOML for the config file only Python 3.11 is released and stable.
* Using TOML for the config file when Python 3.11 is released and stable.

## Requirements
* [Python](https://www.python.org/) >= v3.9, < v3.11 <sub><sup>(Preferably)</sup></sub>
Expand Down Expand Up @@ -88,19 +88,14 @@ root since the output volume binding's permissions can't be properly configured.
docker-compose up --build
```

## Configuration
For information on how to configure the app, check the relevant section on the project's readme.

For information regarding the configuration of this container, all you have to do is change the `/data` volume if you need it in a specific location.

Please note that the [docker-compose.yml](docker/docker-compose.yml) files already has its environment variables set, as well as an independent config file setup.

## Config
The config is stored in [config.json](config.json) and has to be in the same folder as [app.py](app.py), unless the
appropriate [environment variables](#environment-variables) tells the application to look elsewhere for it.

Please refer to [config.md](config.md) for more information on the config file and its fields.

Regarding the configuration of this container, all you have to do is change the `/data` volume if you need it in a specific location.

## Build Arguments *(Docker)*
<table>
<tr>
Expand All @@ -126,6 +121,8 @@ Please refer to [config.md](config.md) for more information on the config file a
## Environment Variables
Any environment variable that is not set will have the effect of its default value.

Please note that the [docker-compose.yml](docker/docker-compose.yml) files already has its environment variables set, as well as an independent config file setup.

<table>
<tr>
<th style="width:25%">Variable</th>
Expand Down
2 changes: 1 addition & 1 deletion yaa/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
VERSION_MINOR = 7
"""Current minor version number of the application"""

VERSION_PATCH = 0
VERSION_PATCH = 1
"""Current patch version number of the application"""

VERSION = "{}.{}.{}".format(VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
Expand Down

0 comments on commit 4556b25

Please sign in to comment.