https://github.com/yunohost/apps_tools

Tools for YunoHost catalog management and application development
https://github.com/yunohost/apps_tools

yunohost

Last synced: 2 months ago
JSON representation

Tools for YunoHost catalog management and application development

• Host: GitHub
• URL: https://github.com/yunohost/apps_tools
• Owner: YunoHost
• License: gpl-3.0
• Created: 2024-05-04T19:29:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-03T13:18:46.000Z (about 1 year ago)
• Last Synced: 2025-01-03T14:30:21.971Z (about 1 year ago)
• Topics: yunohost
• Language: Python
• Size: 814 KB
• Stars: 0
• Watchers: 6
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: readme_generator/README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Auto-README generation

## Initial install

```bash

python3 -m venv venv

source venv/bin/activate

pip install -r requirements.txt

```

## Use on a single app

```bash

source venv/bin/activate

./make_readme.py /path/to/app

```

Then the README.md in the app folder will be updated

## Run tests

```bash

source venv/bin/activate

pip install pytest

pytest tests

```

## Launch webhook service for auto update

Configure the webhook on github

Also need to allow the bot to push on all repos

Configure nginx to reverse proxy on port 8123 (or whichever port you set in the systemd config)

```bash

echo "github_webhook_secret" > github_webhook_secret

echo "the_bot_login" > login

echo "the_bot_token" > token

```

Add the webhook.service to systemd config, then start it:

```bash

systemctl start the_webhook_service 

```