calico-reveal 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- calico_reveal-0.1.0/.gitignore +12 -0
- calico_reveal-0.1.0/PKG-INFO +49 -0
- calico_reveal-0.1.0/README.md +37 -0
- calico_reveal-0.1.0/calico_reveal/__init__.py +0 -0
- calico_reveal-0.1.0/calico_reveal/apps.py +42 -0
- calico_reveal-0.1.0/calico_reveal/templates/widgets/slides.html +46 -0
- calico_reveal-0.1.0/calico_reveal.egg-info/PKG-INFO +49 -0
- calico_reveal-0.1.0/calico_reveal.egg-info/SOURCES.txt +12 -0
- calico_reveal-0.1.0/calico_reveal.egg-info/dependency_links.txt +1 -0
- calico_reveal-0.1.0/calico_reveal.egg-info/entry_points.txt +2 -0
- calico_reveal-0.1.0/calico_reveal.egg-info/requires.txt +1 -0
- calico_reveal-0.1.0/calico_reveal.egg-info/top_level.txt +1 -0
- calico_reveal-0.1.0/pyproject.toml +27 -0
- calico_reveal-0.1.0/setup.cfg +4 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: calico-reveal
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A Calico plugin for a reveal.js widget
|
|
5
|
+
Author: Emma Delescolle
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://calico-ssg.com
|
|
8
|
+
Classifier: Framework :: Django :: 5
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
Requires-Dist: calico_ssg
|
|
12
|
+
|
|
13
|
+
# calico-reveal
|
|
14
|
+
|
|
15
|
+
[](https://pypi.org/project/calico-reveal/)
|
|
16
|
+
[](https://github.com/nanuxbe/calico-reveal/releases)
|
|
17
|
+
[](https://github.com/nanuxbe/calico-reveal/actions?query=workflow%3ATest)
|
|
18
|
+
[](https://github.com/nanuxbe/calico-reveal/blob/main/LICENSE)
|
|
19
|
+
|
|
20
|
+
A Calico plugin to build widget documentation
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
First configure your Django project [to use DJP](https://djp.readthedocs.io/en/latest/installing_plugins.html).
|
|
25
|
+
|
|
26
|
+
Then install this plugin in the same environment as your Django application.
|
|
27
|
+
```bash
|
|
28
|
+
pip install calico-reveal
|
|
29
|
+
```
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
Usage instructions go here.
|
|
33
|
+
|
|
34
|
+
## Development
|
|
35
|
+
|
|
36
|
+
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
|
|
37
|
+
```bash
|
|
38
|
+
cd calico-reveal
|
|
39
|
+
python -m venv venv
|
|
40
|
+
source venv/bin/activate
|
|
41
|
+
```
|
|
42
|
+
Now install the dependencies and test dependencies:
|
|
43
|
+
```bash
|
|
44
|
+
pip install -e '.[test]'
|
|
45
|
+
```
|
|
46
|
+
To run the tests:
|
|
47
|
+
```bash
|
|
48
|
+
python -m pytest
|
|
49
|
+
```
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# calico-reveal
|
|
2
|
+
|
|
3
|
+
[](https://pypi.org/project/calico-reveal/)
|
|
4
|
+
[](https://github.com/nanuxbe/calico-reveal/releases)
|
|
5
|
+
[](https://github.com/nanuxbe/calico-reveal/actions?query=workflow%3ATest)
|
|
6
|
+
[](https://github.com/nanuxbe/calico-reveal/blob/main/LICENSE)
|
|
7
|
+
|
|
8
|
+
A Calico plugin to build widget documentation
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
First configure your Django project [to use DJP](https://djp.readthedocs.io/en/latest/installing_plugins.html).
|
|
13
|
+
|
|
14
|
+
Then install this plugin in the same environment as your Django application.
|
|
15
|
+
```bash
|
|
16
|
+
pip install calico-reveal
|
|
17
|
+
```
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
Usage instructions go here.
|
|
21
|
+
|
|
22
|
+
## Development
|
|
23
|
+
|
|
24
|
+
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
|
|
25
|
+
```bash
|
|
26
|
+
cd calico-reveal
|
|
27
|
+
python -m venv venv
|
|
28
|
+
source venv/bin/activate
|
|
29
|
+
```
|
|
30
|
+
Now install the dependencies and test dependencies:
|
|
31
|
+
```bash
|
|
32
|
+
pip install -e '.[test]'
|
|
33
|
+
```
|
|
34
|
+
To run the tests:
|
|
35
|
+
```bash
|
|
36
|
+
python -m pytest
|
|
37
|
+
```
|
|
File without changes
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
from django.apps import AppConfig
|
|
2
|
+
|
|
3
|
+
from calico import hook
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class CalicoRevealConfig(AppConfig):
|
|
7
|
+
default_auto_field = 'django.db.models.BigAutoField'
|
|
8
|
+
name = 'calico_reveal'
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# # Only use one of those
|
|
12
|
+
# # a theme automatically gets added to installed apps
|
|
13
|
+
# # using both would mean having the installed app twice
|
|
14
|
+
@hook
|
|
15
|
+
# def declare_theme():
|
|
16
|
+
def installed_apps():
|
|
17
|
+
return ['calico_reveal']
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
# @hook
|
|
21
|
+
# def calico_css(theme):
|
|
22
|
+
# pass
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# @hook
|
|
26
|
+
# def calico_js(theme):
|
|
27
|
+
# pass
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
# @hook
|
|
31
|
+
# def site_groupings():
|
|
32
|
+
# pass
|
|
33
|
+
|
|
34
|
+
# @hook
|
|
35
|
+
# def auto_load_tags():
|
|
36
|
+
# return ['calico_reveal.templatetags.reveal']
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
# @hook
|
|
40
|
+
# def calico_defaults():
|
|
41
|
+
# pass
|
|
42
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{% if object.metadata.reveal_css %}
|
|
2
|
+
{% for css in object.metadata.reveal_css %}
|
|
3
|
+
<link rel="stylesheet" href="{% static_or_not css %}">
|
|
4
|
+
{% endfor %}
|
|
5
|
+
{% else %}
|
|
6
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/5.2.1/reset.min.css">
|
|
7
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/5.2.1/reveal.min.css">
|
|
8
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/5.2.1/theme/black.min.css">
|
|
9
|
+
{% endif %}
|
|
10
|
+
|
|
11
|
+
{% if object.metadata.reveal_js %}
|
|
12
|
+
{% for js in object.metadata.reveal_js %}
|
|
13
|
+
<script defer src="{% static_or_not js %}"></script>
|
|
14
|
+
{% endfor %}
|
|
15
|
+
{% else %}
|
|
16
|
+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/5.2.1/reveal.min.js"></script>
|
|
17
|
+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/5.2.1/plugin/markdown/markdown.min.js"></script>
|
|
18
|
+
{% endif %}
|
|
19
|
+
|
|
20
|
+
<div class="reveal">
|
|
21
|
+
<div class="slides">
|
|
22
|
+
<section data-markdown>
|
|
23
|
+
<textarea data-template>
|
|
24
|
+
{{section.content|raw_include}}
|
|
25
|
+
</textarea>
|
|
26
|
+
</object.metadata>
|
|
27
|
+
</div>
|
|
28
|
+
</div>
|
|
29
|
+
|
|
30
|
+
<script>
|
|
31
|
+
document.addEventListener("DOMContentLoaded", () => {
|
|
32
|
+
Reveal.initialize({
|
|
33
|
+
hash: {%if object.metadata.reveal_no_hash == "True" %}false{% else %}true{% endif %},
|
|
34
|
+
history: {%if object.metadata.reveal_no_history == "True" %}false{% else %}true{% endif %},
|
|
35
|
+
width: {{object.metadata.reveal_width|default:1920}},
|
|
36
|
+
height: {{object.metadata.reveal_height|default:1080}},
|
|
37
|
+
margin: {{object.metadata.reveal_margin|default:0.05}},
|
|
38
|
+
minScale: {{object.metadata.reveal_min_scale|default:0.5}},
|
|
39
|
+
maxScale: {{object.metadata.reveal_max_scale|default:4}},
|
|
40
|
+
embedded: true,
|
|
41
|
+
plugins: [
|
|
42
|
+
{{object.metadata.reveal_plugins|default:'RevealMarkdown'}}
|
|
43
|
+
],
|
|
44
|
+
});
|
|
45
|
+
});
|
|
46
|
+
</script>
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: calico-reveal
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A Calico plugin for a reveal.js widget
|
|
5
|
+
Author: Emma Delescolle
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://calico-ssg.com
|
|
8
|
+
Classifier: Framework :: Django :: 5
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
Requires-Dist: calico_ssg
|
|
12
|
+
|
|
13
|
+
# calico-reveal
|
|
14
|
+
|
|
15
|
+
[](https://pypi.org/project/calico-reveal/)
|
|
16
|
+
[](https://github.com/nanuxbe/calico-reveal/releases)
|
|
17
|
+
[](https://github.com/nanuxbe/calico-reveal/actions?query=workflow%3ATest)
|
|
18
|
+
[](https://github.com/nanuxbe/calico-reveal/blob/main/LICENSE)
|
|
19
|
+
|
|
20
|
+
A Calico plugin to build widget documentation
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
First configure your Django project [to use DJP](https://djp.readthedocs.io/en/latest/installing_plugins.html).
|
|
25
|
+
|
|
26
|
+
Then install this plugin in the same environment as your Django application.
|
|
27
|
+
```bash
|
|
28
|
+
pip install calico-reveal
|
|
29
|
+
```
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
Usage instructions go here.
|
|
33
|
+
|
|
34
|
+
## Development
|
|
35
|
+
|
|
36
|
+
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
|
|
37
|
+
```bash
|
|
38
|
+
cd calico-reveal
|
|
39
|
+
python -m venv venv
|
|
40
|
+
source venv/bin/activate
|
|
41
|
+
```
|
|
42
|
+
Now install the dependencies and test dependencies:
|
|
43
|
+
```bash
|
|
44
|
+
pip install -e '.[test]'
|
|
45
|
+
```
|
|
46
|
+
To run the tests:
|
|
47
|
+
```bash
|
|
48
|
+
python -m pytest
|
|
49
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
calico_reveal/__init__.py
|
|
5
|
+
calico_reveal/apps.py
|
|
6
|
+
calico_reveal.egg-info/PKG-INFO
|
|
7
|
+
calico_reveal.egg-info/SOURCES.txt
|
|
8
|
+
calico_reveal.egg-info/dependency_links.txt
|
|
9
|
+
calico_reveal.egg-info/entry_points.txt
|
|
10
|
+
calico_reveal.egg-info/requires.txt
|
|
11
|
+
calico_reveal.egg-info/top_level.txt
|
|
12
|
+
calico_reveal/templates/widgets/slides.html
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
calico_ssg
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
calico_reveal
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools", "setuptools-scm"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "calico-reveal"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "A Calico plugin for a reveal.js widget"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
authors = [{name = "Emma Delescolle"}]
|
|
11
|
+
license = {text = "MIT"}
|
|
12
|
+
classifiers = [
|
|
13
|
+
"Framework :: Django :: 5",
|
|
14
|
+
"License :: OSI Approved :: MIT License"
|
|
15
|
+
]
|
|
16
|
+
dependencies = [
|
|
17
|
+
"calico_ssg",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
[project.urls]
|
|
21
|
+
Homepage = "https://calico-ssg.com"
|
|
22
|
+
|
|
23
|
+
[project.entry-points.djp]
|
|
24
|
+
calico_reveal = "calico_reveal"
|
|
25
|
+
|
|
26
|
+
[tool.setuptools.package-data]
|
|
27
|
+
"*" = ["*.html", "*.js", "*.css"]
|