Skip to content

Commit bd51c4d

Browse files
poingpoing
committed
Documentation update
1 parent 96b4431 commit bd51c4d

4 files changed

Lines changed: 214 additions & 3 deletions

File tree

‎docs/gems/index.html‎

Lines changed: 154 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,17 @@
217217

218218

219219

220+
<label class="md-nav__link md-nav__link--active" for="__toc">
221+
222+
223+
<span class="md-ellipsis">
224+
Gems, Snippets, and Concepts
225+
</span>
226+
227+
228+
<span class="md-nav__icon md-icon"></span>
229+
</label>
230+
220231
<a href="./" class="md-nav__link md-nav__link--active">
221232

222233

@@ -227,6 +238,61 @@
227238

228239
</a>
229240

241+
242+
243+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
244+
245+
246+
247+
248+
249+
250+
<label class="md-nav__title" for="__toc">
251+
<span class="md-nav__icon md-icon"></span>
252+
Table of contents
253+
</label>
254+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
255+
256+
<li class="md-nav__item">
257+
<a href="#organization" class="md-nav__link">
258+
<span class="md-ellipsis">
259+
Organization
260+
</span>
261+
</a>
262+
263+
</li>
264+
265+
<li class="md-nav__item">
266+
<a href="#how-to-use" class="md-nav__link">
267+
<span class="md-ellipsis">
268+
How to Use
269+
</span>
270+
</a>
271+
272+
</li>
273+
274+
<li class="md-nav__item">
275+
<a href="#contributing" class="md-nav__link">
276+
<span class="md-ellipsis">
277+
Contributing
278+
</span>
279+
</a>
280+
281+
</li>
282+
283+
<li class="md-nav__item">
284+
<a href="#license" class="md-nav__link">
285+
<span class="md-ellipsis">
286+
License
287+
</span>
288+
</a>
289+
290+
</li>
291+
292+
</ul>
293+
294+
</nav>
295+
230296
</li>
231297

232298

@@ -397,6 +463,50 @@
397463

398464

399465

466+
<label class="md-nav__title" for="__toc">
467+
<span class="md-nav__icon md-icon"></span>
468+
Table of contents
469+
</label>
470+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
471+
472+
<li class="md-nav__item">
473+
<a href="#organization" class="md-nav__link">
474+
<span class="md-ellipsis">
475+
Organization
476+
</span>
477+
</a>
478+
479+
</li>
480+
481+
<li class="md-nav__item">
482+
<a href="#how-to-use" class="md-nav__link">
483+
<span class="md-ellipsis">
484+
How to Use
485+
</span>
486+
</a>
487+
488+
</li>
489+
490+
<li class="md-nav__item">
491+
<a href="#contributing" class="md-nav__link">
492+
<span class="md-ellipsis">
493+
Contributing
494+
</span>
495+
</a>
496+
497+
</li>
498+
499+
<li class="md-nav__item">
500+
<a href="#license" class="md-nav__link">
501+
<span class="md-ellipsis">
502+
License
503+
</span>
504+
</a>
505+
506+
</li>
507+
508+
</ul>
509+
400510
</nav>
401511
</div>
402512
</div>
@@ -414,7 +524,50 @@
414524

415525

416526
<h1 id="gems-snippets-and-concepts">Gems, Snippets, and Concepts</h1>
417-
<p>Something about getting to a working Python and JavaScript interop will go here.</p>
527+
<p>The "gems" directory is a place for experimentation! 🚀 Here, you'll find a collection of code snippets that serve as proof-of-concept (PoC) implementations. These snippets, while not directly used in the project, have been valuable in the development process. They've provided insights, solutions, or innovative approaches that have contributed to the overall success of the project.</p>
528+
<!--
529+
## Purpose
530+
531+
- **Idea Exploration:** The snippets in this directory were created during the exploration phase, where various ideas and concepts were tested before implementation in the main project codebase.
532+
533+
- **Problem Solving:** These code snippets may contain solutions to specific challenges or problems encountered during development. While they might not be part of the final code, they showcase different approaches to problem-solving.
534+
535+
- **Learning and Experimentation:** The "gems" directory is also a space for experimentation and learning. Developers can refer to these PoCs to understand different techniques and methodologies.
536+
-->
537+
538+
<div class="grid cards">
539+
<ul>
540+
<li>
541+
<p><span class="twemoji lg middle"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M156.6 384.9 125.7 354c-8.5-8.5-11.5-20.8-7.7-32.2 3-8.9 7-20.5 11.8-33.8H24c-8.6 0-16.6-4.6-20.9-12.1s-4.2-16.7.2-24.1l52.5-88.5c13-21.9 36.5-35.3 61.9-35.3H200c2.4-4 4.8-7.7 7.2-11.3C289.1-4.1 411.1-8.1 483.9 5.3c11.6 2.1 20.6 11.2 22.8 22.8 13.4 72.9 9.3 194.8-111.4 276.7-3.5 2.4-7.3 4.8-11.3 7.2v82.3c0 25.4-13.4 49-35.3 61.9l-88.5 52.5c-7.4 4.4-16.6 4.5-24.1.2S224 496.7 224 488V380.8c-14.1 4.9-26.4 8.9-35.7 11.9-11.2 3.6-23.4.5-31.8-7.8zM384 168a40 40 0 1 0 0-80 40 40 0 1 0 0 80z"/></svg></span> <strong>Exploration</strong></p>
542+
<hr />
543+
<p>The snippets were created during the exploration phase, where various ideas and concepts were tested before implementation in the main project codebase.</p>
544+
</li>
545+
<li>
546+
<p><span class="twemoji lg middle"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2s-6.3 25.5 4.1 33.7l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L477.4 348.9c1.7-9.4 2.6-19 2.6-28.9h64c17.7 0 32-14.3 32-32s-14.3-32-32-32h-64.3c-1.1-14.1-5-27.5-11.1-39.5.7-.6 1.4-1.2 2.1-1.9l64-64c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-64 64c-.7.7-1.3 1.4-1.9 2.1-14.3-7.3-30.4-11.4-47.5-11.4H264c-8.3 0-16.3 1-24 2.8L38.8 5.1zm392 430.3L336 360.7v118.5c36.6-3.6 69.7-19.6 94.8-43.8zM166.7 227.3c-3.4 9-5.6 18.7-6.4 28.7H96c-17.7 0-32 14.3-32 32s14.3 32 32 32h64c0 24.6 5.5 47.8 15.4 68.6-2.2 1.3-4.2 2.9-6 4.8l-64 64c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0l63.1-63.1c24.5 21.8 55.8 36.2 90.3 39.6V335.5L166.7 227.3zM320 0c-53 0-96 43-96 96v3.6c0 15.7 12.7 28.4 28.4 28.4h135.2c15.7 0 28.4-12.7 28.4-28.4V96c0-53-43-96-96-96z"/></svg></span> <strong>Problem Solving</strong></p>
547+
<hr />
548+
<p>Some code snippets may contain solutions to specific challenges or problems encountered during development. While they might not be part of the final code, they showcase different approaches to problem-solving.</p>
549+
</li>
550+
<li>
551+
<p><span class="twemoji lg middle"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M499.6 11.3c6.7-10.7 20.5-14.5 31.7-8.5s15.8 19.5 10.6 31L404.8 338.6c2.2 2.3 4.3 4.7 6.3 7.1l97.2-54.7c10.5-5.9 23.6-3.1 30.9 6.4s6.3 23-2.2 31.5l-87 87h-71.5c-13.2-37.3-48.7-64-90.5-64s-77.4 26.7-90.5 64h-79.7l-75.5-52.2c-9.7-6.7-13.1-19.6-7.9-30.3s17.4-15.9 28.7-12.4l97.2 30.4c3-3.9 6.1-7.7 9.4-11.3l-62.3-103.8c-6.1-10.1-3.9-23.1 5.1-30.7s22.2-7.5 31.1.1L246 293.6c1.5-.4 3-.8 4.5-1.1l13.6-142.7c1.2-12.3 11.5-21.7 23.9-21.7s22.7 9.4 23.9 21.7l13.5 141.9L499.6 11.3zM64 448h480c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32h32zM288 0c13.3 0 24 10.7 24 24v48c0 13.3-10.7 24-24 24s-24-10.7-24-24V24c0-13.3 10.7-24 24-24z"/></svg></span> <strong>Experimentation</strong></p>
552+
<hr />
553+
<p>The "gems" directory is also a space for experimentation and learning. Developers can refer to these PoCs to understand different techniques and methodologies.</p>
554+
</li>
555+
<li>
556+
<p><span class="twemoji lg middle"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7 2v2h1v14a4 4 0 0 0 4 4 4 4 0 0 0 4-4V4h1V2H7m4 14c-.6 0-1-.4-1-1s.4-1 1-1 1 .4 1 1-.4 1-1 1m2-4c-.6 0-1-.4-1-1s.4-1 1-1 1 .4 1 1-.4 1-1 1m1-5h-4V4h4v3Z"/></svg></span> <strong>Testing</strong></p>
557+
<hr />
558+
<p>Some of the code may be used to test some challenge of concept, before it's implemented in the final code.</p>
559+
</li>
560+
</ul>
561+
</div>
562+
<h2 id="organization">Organization</h2>
563+
<p>The directory is organized with each code snippet placed in a separate file or subdirectory, named descriptively to indicate its purpose or the problem it addresses. Additionally, a brief explanation is provided within each file to give context and insights into the PoC.</p>
564+
<h2 id="how-to-use">How to Use</h2>
565+
<p>While the code in this directory is not directly integrated into the main project, you may find value in reviewing these snippets for reference or inspiration. If a particular PoC aligns with a current or future project requirement, feel free to adapt and incorporate the code into your work.</p>
566+
<h2 id="contributing">Contributing</h2>
567+
<p>If you have additional PoCs or innovative code snippets that you believe could benefit the project, consider contributing them to this directory. Follow the contribution guidelines outlined in the project's main README.</p>
568+
<h2 id="license">License</h2>
569+
<p>All code snippets in this directory are provided under the <a href="https://github.com/poing/JS2PySecrets/blob/main/LICENSE">project's license</a>. Please review the license before using or distributing any code from this directory.</p>
570+
<p>Happy coding! 🎉</p>
418571

419572

420573

‎docs/sitemap.xml.gz‎

0 Bytes
Binary file not shown.

‎docs_source/gems.md‎

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,61 @@
11
# Gems, Snippets, and Concepts
22

3-
Something about getting to a working Python and JavaScript interop will go here.
3+
The "gems" directory is a place for experimentation! 🚀 Here, you'll find a collection of code snippets that serve as proof-of-concept (PoC) implementations. These snippets, while not directly used in the project, have been valuable in the development process. They've provided insights, solutions, or innovative approaches that have contributed to the overall success of the project.
4+
5+
<!--
6+
## Purpose
7+
8+
- **Idea Exploration:** The snippets in this directory were created during the exploration phase, where various ideas and concepts were tested before implementation in the main project codebase.
9+
10+
- **Problem Solving:** These code snippets may contain solutions to specific challenges or problems encountered during development. While they might not be part of the final code, they showcase different approaches to problem-solving.
11+
12+
- **Learning and Experimentation:** The "gems" directory is also a space for experimentation and learning. Developers can refer to these PoCs to understand different techniques and methodologies.
13+
-->
14+
15+
16+
<div class="grid cards" markdown>
17+
18+
- :fontawesome-solid-rocket:{ .lg .middle } __Exploration__
19+
20+
---
21+
22+
The snippets were created during the exploration phase, where various ideas and concepts were tested before implementation in the main project codebase.
23+
24+
- :fontawesome-solid-bug-slash:{ .lg .middle } __Problem Solving__
25+
26+
---
27+
28+
Some code snippets may contain solutions to specific challenges or problems encountered during development. While they might not be part of the final code, they showcase different approaches to problem-solving.
29+
30+
- :fontawesome-solid-explosion:{ .lg .middle } __Experimentation__
31+
32+
---
33+
34+
The "gems" directory is also a space for experimentation and learning. Developers can refer to these PoCs to understand different techniques and methodologies.
35+
36+
- :material-test-tube:{ .lg .middle } __Testing__
37+
38+
---
39+
40+
Some of the code may be used to test some challenge of concept, before it's implemented in the final code.
41+
42+
43+
</div>
44+
45+
## Organization
46+
47+
The directory is organized with each code snippet placed in a separate file or subdirectory, named descriptively to indicate its purpose or the problem it addresses. Additionally, a brief explanation is provided within each file to give context and insights into the PoC.
48+
49+
## How to Use
50+
51+
While the code in this directory is not directly integrated into the main project, you may find value in reviewing these snippets for reference or inspiration. If a particular PoC aligns with a current or future project requirement, feel free to adapt and incorporate the code into your work.
52+
53+
## Contributing
54+
55+
If you have additional PoCs or innovative code snippets that you believe could benefit the project, consider contributing them to this directory. Follow the contribution guidelines outlined in the project's main README.
56+
57+
## License
58+
59+
All code snippets in this directory are provided under the [project's license](https://github.com/poing/JS2PySecrets/blob/main/LICENSE). Please review the license before using or distributing any code from this directory.
60+
61+
Happy coding! 🎉

‎tests/test_SecretsSpec.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def test_withASCII():
2121

2222

2323
@pytest.mark.skipif(
24-
sys.platform == "win32", reason="Windows default to CP-1252"
24+
sys.platform.startswith("win"), reason="Windows default to CP-1252"
2525
)
2626
def test_with_UTF8():
2727
key = "¥ · £ · € · $ · ¢ · ₡ · ₢ · ₣ · ₤ · ₥ · ₦ · ₧ · ₨ · ₩ · ₪ · ₫ · ₭ · ₮ · ₯ · ₹"

0 commit comments

Comments
 (0)