Skip to content

Commit 5005081

Browse files
committed
wip: preparing repo md & translations
1 parent b0af160 commit 5005081

File tree

4 files changed

+28
-206
lines changed

4 files changed

+28
-206
lines changed

extras/github/bug_report.yml

Lines changed: 0 additions & 96 deletions
This file was deleted.

extras/github/feature_request.yml

Lines changed: 0 additions & 26 deletions
This file was deleted.

extras/wrapped.md

Lines changed: 27 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -2,108 +2,52 @@
22
layout: plugin
33

44
id: wrapped
5-
title: OctoPrint-Wrapped
6-
description: Get your yearly stats!
5+
title: OctoPrint Wrapped! 🎁
6+
description: Get your yearly stats and let it snow!
77
authors:
8-
- Gina Häußge
8+
- Gina Häußge
99
license: AGPL-3.0-or-later
1010

11-
# TODO
12-
date: today's date in format YYYY-MM-DD, e.g. 2015-04-21
11+
date: 2025-12-09
1312

1413
homepage: https://github.com/OctoPrint/OctoPrint-Wrapped
1514
source: https://github.com/OctoPrint/OctoPrint-Wrapped
1615
archive: https://github.com/OctoPrint/OctoPrint-Wrapped/archive/main.zip
1716

18-
# TODO
19-
# Set this to true if your plugin uses the dependency_links setup parameter to include
20-
# library versions not yet published on PyPi. SHOULD ONLY BE USED IF THERE IS NO OTHER OPTION!
21-
#follow_dependency_links: false
22-
23-
# TODO
2417
tags:
25-
- a list
26-
- of tags
27-
- that apply
28-
- to your plugin
29-
- (take a look at the existing plugins for what makes sense here)
18+
- stats
19+
- achievements
20+
- wrapped
21+
- fun
22+
- seasonal
23+
- snow
3024

31-
# TODO
32-
# When registering a plugin on plugins.octoprint.org, all screenshots should be uploaded not linked from external sites.
3325
screenshots:
34-
- url: url of a screenshot, /assets/img/...
35-
alt: alt-text of a screenshot
36-
caption: caption of a screenshot
37-
- url: url of another screenshot, /assets/img/...
38-
alt: alt-text of another screenshot
39-
caption: caption of another screenshot
40-
- ...
26+
- url: url of a screenshot, /assets/img/...
27+
alt: alt-text of a screenshot
28+
caption: caption of a screenshot
29+
- url: url of another screenshot, /assets/img/...
30+
alt: alt-text of another screenshot
31+
caption: caption of another screenshot
32+
- ...
4133

42-
# TODO
4334
featuredimage: url of a featured image for your plugin, /assets/img/...
4435

45-
# TODO
46-
# You only need the following if your plugin requires specific OctoPrint versions or
47-
# specific operating systems to function - you can safely remove the whole
48-
# "compatibility" block if this is not the case.
49-
5036
compatibility:
51-
52-
# List of compatible versions
53-
#
54-
# A single version number will be interpretated as a minimum version requirement,
55-
# e.g. "1.3.1" will show the plugin as compatible to OctoPrint versions 1.3.1 and up.
56-
# More sophisticated version requirements can be modelled too by using PEP440
57-
# compatible version specifiers.
58-
#
59-
# You can also remove the whole "octoprint" block. Removing it will default to all
60-
# OctoPrint versions being supported.
61-
62-
octoprint:
63-
- 1.4.0
64-
65-
# List of compatible operating systems
66-
#
67-
# Valid values:
68-
#
69-
# - windows
70-
# - linux
71-
# - macos
72-
# - freebsd
73-
#
74-
# There are also two OS groups defined that get expanded on usage:
75-
#
76-
# - posix: linux, macos and freebsd
77-
# - nix: linux and freebsd
78-
#
79-
# You can also remove the whole "os" block. Removing it will default to all
80-
# operating systems being supported.
81-
82-
os:
83-
- linux
84-
- windows
85-
- macos
86-
- freebsd
87-
88-
# Compatible Python version
89-
#
90-
# It is recommended to only support Python 3 for new plugins, in which case this should be ">=3,<4"
91-
#
92-
# Plugins that wish to support both Python 2 and 3 should set it to ">=2.7,<4".
93-
#
94-
# Plugins that only support Python 2 will not be accepted into the plugin repository.
95-
96-
python: ">=3,<4"
97-
98-
# TODO
99-
# If any of the below attributes apply to your project, uncomment the corresponding lines. This is MANDATORY!
37+
octoprint:
38+
- 1.11.0
39+
python: ">=3.9,<4"
10040

10141
attributes:
10242
# - cloud # if your plugin requires access to a cloud to function
10343
# - commercial # if your plugin has a commercial aspect to it
10444
# - free-tier # if your plugin has a free tier
105-
10645
---
10746

108-
**TODO**: Longer description of your plugin, configuration examples etc. This part will be visible on the page at
109-
http://plugins.octoprint.org/plugin/wrapped/
47+
Get your yearly OctoPrint stats a shareable "wrapped" picture - and let it snow! ❄️
48+
49+
The stats picture depends on the Achievements plugin being enabled (as it takes care of
50+
the stats collection during the year). The snow effect can always be toggled during
51+
the season and its setting persists through the browser's local storage.
52+
53+
Both wrapped and snowfall are only available from December 1st until January 10th.

translations/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you want to bundle translations with your plugin, create a new folder
1717
an additional command becomes available:
1818

1919
go-task babel-bundle
20-
Moves the translations for the locales defined in Taskfile.yml to
20+
Moves the translations for the locales defined in Taskfile.yml to
2121
octoprint_wrapped/translations,
2222
effectively bundling them with your plugin. This is interesting for languages
2323
you can guarantee to keep up to date yourself with each new release of your

0 commit comments

Comments
 (0)