Python code snippets for markdown files, e.g READMEs, from actual (testable) code.
Project description
🏠Home • 🎇Features • 🔨Install • 🚜Usage • 💻CLI • 💡Examples
🤖Jinja2 API • ✅Requirements • 🐳Docker • 🚸Gotchas
❔ What
What it does: Snipinator lets you take a EXAMPLE.md
template
and include snippets from your (working and tested) codebase.
Turn this (./snipinator/examples/SIMPLE.md.jinja2):
# A README
Here is a code snippet:
<!--{{ pysnippet(path='snipinator/examples/code.py', symbol='MyClass', backtickify='py', decomentify='nl') }}-->
Note that `code.py` has a test:
{{path('./snipinator/examples/code_test.py', link='md')}}.
Into this (./snipinator/examples/SIMPLE.generated.md):
<!--
WARNING: This file is auto-generated by snipinator. Do not edit directly.
SOURCE: `snipinator/examples/SIMPLE.md.jinja2`.
-->
# A README
Here is a code snippet:
<!---->
```py
class MyClass:
"""This is a global class"""
def __init__(self, name):
self.name = name
def MyClassMethod(self):
"""This is a method of MyClass"""
print(self.name)
```
<!---->
Note that `code.py` has a test:
[./snipinator/examples/code_test.py](./snipinator/examples/code_test.py).
🎇 Features
- 📦✅🪄 Supports anything Jinja2 supports.
- 🥇🐍📜 First-class support for python source code.
- Can include python function signatures, docstrings, entire function source code, classes.
- ✂🌐🗂️ Snip from any source code language.
- Put delimiter markers into the code (e.g
# START_SNIPPET
,# END_TEMPLATE
), and use snippet().
- Put delimiter markers into the code (e.g
- 🥇🔖📜 First-class support for Markdown templates (with
backtickify
,decomentify
). - 📦🐚🖨️ Can include shell output.
- Supports ANSI colors :heart: :green_heart: :blue_heart: with SVG output :camera:.
- ⚙️🔗🗃️ More robust references/links to local files using path().
- 🐳🌊🖥️ Docker Image (See README: Docker Image).
🔨 Install
# Install from pypi (https://pypi.org/project/snipinator/)
pip install snipinator
# Install from git (https://github.com/realazthat/snipinator)
pip install git+https://github.com/realazthat/snipinator.git@v3.1.2
🚜 Usage
Example template README: (./snipinator/examples/SIMPLE.md.jinja2):
# A README
Here is a code snippet:
<!--{{ pysnippet(path='snipinator/examples/code.py', symbol='MyClass', backtickify='py', decomentify='nl') }}-->
Note that `code.py` has a test:
{{path('./snipinator/examples/code_test.py', link='md')}}.
Generating the README:
$ python -m snipinator.cli -t snipinator/examples/SIMPLE.md.jinja2
<!--
WARNING: This file is auto-generated by snipinator. Do not edit directly.
SOURCE: `snipinator/examples/SIMPLE.md.jinja2`.
-->
# A README
Here is a code snippet:
<!---->
```py
class MyClass:
"""This is a global class"""
def __init__(self, name):
self.name = name
def MyClassMethod(self):
"""This is a method of MyClass"""
print(self.name)
```
<!---->
Note that `code.py` has a test:
[./snipinator/examples/code_test.py](./snipinator/examples/code_test.py).
Fuller example:
💻 Command Line Options
💡 Examples
- Snipinator's own
README
:- Template: ./.github/README.md.jinja2.
- Generated: ./README.md.
- Generation script: ./scripts/generate-readme.sh.
- Example:
- Template: ./snipinator/examples/SIMPLE.md.jinja2.
- Generated: ./snipinator/examples/SIMPLE.generated.md.
- Generation script: ./snipinator/examples/simple_example.sh.
- Long example of many features:
- Template: ./snipinator/examples/LONG-EXAMPLE.md.jinja2.
- Generated: ./snipinator/examples/LONG-EXAMPLE.generated.md.
- Generation script: ./snipinator/examples/long_example.sh.
- Projects using Snipinator:
- realazthat/snipinator
- Template: ./.github/README.md.jinja2.
- Generated: snipinator/README.md.
- Generation script: snipinator/scripts/generate-readme.sh#L20.
- realazthat/mdremotifier.
- Template: mdremotifier/README.md.jinja2.
- Generated: mdremotifier/README.md.
- Generation script: mdremotifier/generate-readme.sh#L20.
- realazthat/changeguard.
- Template: changeguard/README.md.jinja2.
- Generated: changeguard/README.md.
- Generation script: changeguard/generate-readme.sh#L20.
- realazthat/excalidraw-brute-export-cli,
- Template: excalidraw-brute-export-cli/README.md.jinja2.
- Generated: excalidraw-brute-export-cli/README.md.
- Generation script: excalidraw-brute-export-cli/generate-readme.sh#L65.
- realazthat/comfy-catapult.
- Template: comfy-catapult/README.md.jinja2.
- Generated: comfy-catapult/README.md.
- Generation script: comfy-catapult/generate-readme.sh#L17.
- realazthat/comfylowda.
- Template: comfylowda/README.md.jinja2.
- Generated: comfylowda/README.md.
- Generation script: comfylowda/generate-readme.sh#L17.
- realazthat/snipinator
🤖 Jinja2 API
The regular Jinja2 v3 template syntax is supported. For more information, see Template Designer Documentation.
Additional (Jinja2) functions made available:
🐍✂ pysnippet
Used several times in ./snipinator/examples/LONG-EXAMPLE.md.jinja2.
Documentation:
def pysnippet(path: str,
symbol: Optional[str],
*,
escape: bool = False,
indent: Union[str, int, None] = None,
indented: Union[str, int, None] = None,
backtickify: Union[bool, str] = False,
decomentify: Union[bool, Literal['nl']] = False,
_ctx: _Context) -> Union[str, markupsafe.Markup]:
"""Return a python snippet, allowing you to specify a class or function.
Args:
path (str): The path to the file.
symbol (Optional[str]): The symbol to extract. If None, the entire file is
returned. Defaults to None.
escape (bool, optional): Should use HTML entities escaping? Defaults to
False.
indent (Union[str, int, None], optional): Should indent? By how much, or
with what prefix? Defaults to None.
indented (Union[str, int, None], optional): Indents every line except the
first. By how much, or with what prefix? Defaults to None.
backtickify (Union[bool, str], optional): Should surround with backticks?
With what language? Defaults to False.
decomentify (Union[bool, Literal['nl']], optional): Assuming that you will
be using HTML comments around this call, setting this to true will add
correspondingcomments to uncomment the output. This allows you to have
the Jinja2 call unmolested by markdown formatters, because they will be
inside of a comment section. "nl" adds additional newlines after the
newline delimiters. Defaults to False.
_ctx (_Context): This is used by the system and is not available as an
argument.
Returns:
Union[str, markupsafe.Markup]: The snippet.
"""
🐍📖 pysignature
Used several times in ./.github/README.md.jinja2.
Documentation:
def pysignature(path: str,
symbol: str,
*,
escape: bool = False,
indent: Union[str, int, None] = None,
indented: Union[str, int, None] = None,
backtickify: Union[bool, str] = False,
decomentify: Union[bool, Literal['nl']] = False,
_ctx: _Context) -> str:
"""Return the signature of a class or function in a python file.
Returns the {class,function} signature and the docstring.
Args:
path (str): The path to the file.
symbol (str): The symbol to extract.
escape (bool, optional): Should use HTML entities escaping? Defaults to
False.
indent (Union[str, int, None], optional): Should indent? By how much, or
with what prefix? Defaults to None.
indented (Union[str, int, None], optional): Indents every line except the
first. By how much, or with what prefix? Defaults to None.
backtickify (Union[bool, str], optional): Should surround with backticks?
With what language? Defaults to False.
decomentify (Union[bool, Literal['nl']], optional): Assuming that you will
be using HTML comments around this call, setting this to true will add
correspondingcomments to uncomment the output. This allows you to have
the Jinja2 call unmolested by markdown formatters, because they will be
inside of a comment section. "nl" adds additional newlines after the
newline delimiters. Defaults to False.
_ctx (_Context): This is used by the system and is not available as an
argument.
Returns:
str: The signature and docstring.
"""
✂ rawsnippet
Used several times in ./.github/README.md.jinja2.
Documentation:
def rawsnippet(path: str,
*,
escape: bool = False,
indent: Union[str, int, None] = None,
indented: Union[str, int, None] = None,
backtickify: Union[bool, str] = False,
decomentify: Union[bool, Literal['nl']] = False,
_ctx: _Context) -> Union[str, markupsafe.Markup]:
"""Return an entire file as a snippet.
Args:
path (str): The path to the file.
escape (bool, optional): Should use HTML entities escaping? Defaults to
False.
indent (Union[str, int, None], optional): Should indent? By how much, or
with what prefix? Defaults to None.
indented (Union[str, int, None], optional): Indents every line except the
first. By how much, or with what prefix? Defaults to None.
backtickify (Union[bool, str], optional): Should surround with backticks?
With what language? Defaults to False.
decomentify (Union[bool, Literal['nl']], optional): Assuming that you will
be using HTML comments around this call, setting this to true will add
correspondingcomments to uncomment the output. This allows you to have
the Jinja2 call unmolested by markdown formatters, because they will be
inside of a comment section. "nl" adds additional newlines after the
newline delimiters. Defaults to False.
_ctx (_Context): This is used by the system and is not available as an
argument.
Returns:
Union[str, markupsafe.Markup]: The snippet.
"""
✂ snippet
Example in ./snipinator/examples/LONG-EXAMPLE.md.jinja2.
Documentation:
def snippet(path: str,
start: str,
end: str,
*,
escape: bool = False,
indent: Union[str, int, None] = None,
indented: Union[str, int, None] = None,
backtickify: Union[bool, str] = False,
decomentify: Union[bool, Literal['nl']] = False,
regex: Union[bool, str] = False,
_ctx: _Context) -> Union[str, markupsafe.Markup]:
"""Returns a _delimited_ snippet from a file.
Does not return the delimiters themselves.
Args:
path (str): The path to the file.
start (str): A string that indicates the start of the snippet.
end (str): A string that indicates the end of the snippet.
escape (bool, optional): Should use HTML entities escaping? Defaults to
False.
indent (Union[str, int, None], optional): Should indent? By how much, or
with what prefix? Defaults to None.
indented (Union[str, int, None], optional): Indents every line except the
first. By how much, or with what prefix? Defaults to None.
backtickify (Union[bool, str], optional): Should surround with backticks?
With what language? Defaults to False.
decomentify (Union[bool, Literal['nl']], optional): Assuming that you will
be using HTML comments around this call, setting this to true will add
correspondingcomments to uncomment the output. This allows you to have
the Jinja2 call unmolested by markdown formatters, because they will be
inside of a comment section. "nl" adds additional newlines after the
newline delimiters. Defaults to False.
regex (Union[bool, str], optional): If True, `start` and `end` will be
treated as regular expressions. Optionally, can pass in python regex
flags separated by `|` characters, e.g "IGNORECASE|MULTILINE". Defaults
to False.
_ctx (_Context): This is used by the system and is not available as an
argument.
Returns:
Union[str, markupsafe.Markup]: The snippet.
"""
🐚 shell
Used several times in ./.github/README.md.jinja2.
Documentation:
def shell(args: str,
*,
escape: bool = False,
indent: Union[str, int, None] = None,
indented: Union[str, int, None] = None,
backtickify: Union[bool, str] = False,
decomentify: Union[bool, Literal['nl']] = False,
rich: Union[Literal['svg'], Literal['img+b64+svg'], Literal['raw'],
str] = 'raw',
rich_alt: Optional[str] = None,
rich_bg_color: Optional[str] = None,
rich_term: Optional[str] = None,
rich_rows: int = 24,
rich_cols: int = 80,
include_args: bool = True,
start: Optional[str] = None,
end: Optional[str] = None,
regex: Union[bool, str] = False,
_ctx: _Context) -> Union[str, markupsafe.Markup]:
"""Run a shell command and return the output.
Use at your own risk, this can potentially introduce security vulnerabilities.
Only use if you know what you are doing. Ensure that no untrusted input can
be injected into the `args` parameter, or, into anything the command might
access. If an adversary can control the `args` parameter, they can execute
arbitrary commands on your system.
Note: On persistent output colors:
* I found that the environment variables TERM, COLORTERM and FORCE_COLOR,
CLI_WIDTH, COLUMNS also influence the outputs for some applications.
* Also various library versions used in various programs, e.g colorama,
rich-argparse, Pygments might influence the output.
* I had to pin all my python packages, and explicitly set TERM, COLORTERM and
FORCE_COLOR, CLI_WIDTH, COLUMNS to get the output to be consistent across
two different systems, both using Ubuntu, for a single program.
Args:
args (str): The command to run.
escape (bool, optional): Should use HTML entities escaping? Defaults to
False.
indent (Union[str, int, None], optional): Should indent? By how much, or
with what prefix? Defaults to None.
indented (Union[str, int, None], optional): Indents every line except the
first. By how much, or with what prefix? Defaults to None.
backtickify (Union[bool, str], optional): Should surround with backticks?
With what language? Defaults to False.
decomentify (bool, optional): Assuming that you will be using HTML
comments around this call, setting this to true will add corresponding
uncomments to uncomment the output. This allows you to have the Jinja2
call unmolested by markdown formatters, because they will be inside of
a comment section. Defaults to False.
rich (Union[Literal['svg'], Literal['img+b64+svg'], Literal['raw'], str],
optional):
Optionally outputs colored terminal output as an image.
* If `rich` is a relative file path that ends with ".svg", the svg will
be saved to that location and an img tag will be emitted. The path
will be relative to the template file, which is specified on the
command line. If the template is from stdin, the path will be relative
to the current working directory (cwd) which is also specified on the
command line.
* If 'svg' a raw svg tag will be dumped into the markdown with the
colored terminal output. Note that your markdown renderer may not
support this.
* If 'img+svg' a base64 encoded image will be dumped into the markdown
with the colored terminal output.
* If 'raw' the raw (uncolored) terminal output will be dumped into the
markdown directly.
* Defaults to 'raw.
rich_alt (str, optional): The alt text for the img tag. Defaults
to None.
rich_bg_color (str, optional): The background color for the
terminal output. Valid colors include anything valid for SVG colors. See
<https://developer.mozilla.org/en-US/docs/Web/CSS/color>. Defaults to
None (fully transparent).
rich_term: (str, optional): Sets the TERM env var. Defaults to
None, which uses whatever the env vars already have.
rich_rows (int, optional): The number of rows to use for the terminal
output. Doesn't seem to have much effect. Defaults to 24.
rich_cols (int, optional): The number of columns to use for the terminal
output. Defaults to 80.
include_args (bool, optional): Should include the command that was run in
the output? Defaults to True.
start (str, optional): If specified, will return only the text after this
delimiter. Defaults to None.
end (str, optional): If specified, will return only the text before this
delimiter. Defaults to None.
regex (Union[bool, str], optional): If True, `start` and `end` will be
treated as regular expressions. Optionally, can pass in python regex
flags separated by `|` characters, e.g "IGNORECASE|MULTILINE". Defaults
to False.
_ctx (_Context): This is used by the system and is not available as an
argument.
Returns:
Union[str, markupsafe.Markup]: Returns the output of the command.
"""
🌀 path
Used several times in ./.github/README.md.jinja2.
Documentation:
def path(path: str,
*,
escape: bool = False,
indent: Union[str, int, None] = None,
indented: Union[str, int, None] = None,
backtickify: Union[bool, str] = False,
decomentify: Union[bool, Literal['nl']] = False,
link: Optional[Literal['md', 'html']] = None,
text: Optional[str] = None,
_ctx: _Context) -> Union[str, markupsafe.Markup]:
"""Verifies that `path` exists, and just returns `path`.
Unfortunately, I don't know how to use this inside a link, because the
formatters will destroy it, and it cannot be put into a code block (as the url
section of a link in markdown does not allow code blocks).
Args:
path (str): The path to verify.
escape (bool, optional): Should use HTML entities escaping? Defaults to
False.
indent (Union[str, int, None], optional): Should indent? By how much, or
with what prefix? Defaults to None.
indented (Union[str, int, None], optional): Indents every line except the
first. By how much, or with what prefix? Defaults to None.
backtickify (Union[bool, str], optional): Should surround with backticks?
With what language? Defaults to False.
decomentify (Union[bool, Literal['nl']], optional): Assuming that you will
be using HTML comments around this call, setting this to true will add
correspondingcomments to uncomment the output. This allows you to have
the Jinja2 call unmolested by markdown formatters, because they will be
inside of a comment section. "nl" adds additional newlines after the
newline delimiters. Defaults to False.
link (Literal['md', 'html'], optional): If specified, will
return a markdown or html link to the path. Defaults to None.
text (str, optional): If specified, will use this text as the
return value instead of the path. If used with link, will return this
text as the link text instead of the path. Defaults to None.
_ctx (_Context): This is used by the system and is not available as an
argument.
Returns:
Union[str, markupsafe.Markup]: Just returns the path. If the path doesn't
exist, it will raise an error.
"""
✅ Requirements
- Linux-like environment
- Why: Uses pexpect.spawn().
- Python 3.8+
- Why: Some dev dependencies require Python 3.8+.
Tested Platforms
- WSL2 Ubuntu 20.04, Python
3.8.0
. - Ubuntu 20.04, Python
3.8.0, 3.9.0, 3.10.0, 3.11.0, 3.12.0
, tested in GitHub Actions workflow (build-and-test.yml).
🐳 Docker Image
Docker images are published to ghcr.io/realazthat/snipinator at each tag.
# View the template file.
cat "snipinator/examples/SIMPLE.md.jinja2"
# Use the published images at ghcr.io/realazthat/snipinator.
# /data in the docker image is the working directory, so paths are simpler.
docker run --rm --tty \
-u "$(id -u):$(id -g)" \
-v "${PWD}:/data" \
ghcr.io/realazthat/snipinator:v3.1.2 \
-t "snipinator/examples/SIMPLE.md.jinja2" \
--rm \
--force \
--create \
-o "snipinator/examples/SIMPLE.generated.md" \
--chmod-ro \
--skip-unchanged
# View the generated file.
cat "snipinator/examples/SIMPLE.generated.md"
If you want to build the image yourself, you can use the Dockerfile in the repository.
docker build -t my-snipinator-image .
# View the template file.
cat "snipinator/examples/SIMPLE.md.jinja2"
# /data in the docker image is the working directory, so paths are simpler.
docker run --rm --tty \
-u "$(id -u):$(id -g)" \
-v "${PWD}:/data" \
my-snipinator-image \
-t "snipinator/examples/SIMPLE.md.jinja2" \
--rm \
--force \
--create \
-o "snipinator/examples/SIMPLE.generated.md" \
--chmod-ro \
--skip-unchanged
# View the generated file.
cat "snipinator/examples/SIMPLE.generated.md"
🚸 Gotchas and Limitations
- Security: This tool is NOT designed to be used with untrusted input. It is designed to be used with your own codebase. Even when using your own input, be careful that your own code won't be doing anything that might inadvertently include untrusted input.
- Be careful to escape
{{
and}}
, or{%
and%}
or anything jinja2 is sensitive to, in the templates. You'll have to escape it properly for jinja2, which involves using{% raw %}
and{% endraw %}
tags. - Recursion: Snipinator doesn't directly support recursive inclusion of generated content. You can generate the contents of one file first, and include that generated content into another template. This would mean that you have to worry about order of generation.
- Embedded Backticks: If there are backticks in the included snippet, it might
ruin the backticks you have in your markdown. This is why
backtickify
parameter exists in the API, so that Snipinator provides the backticks, and it will detect if there are backticks in the snippet and use a different number of backticks on the entire snippet. So if the snippet contains```My Snippet```
, Snipinator will use````language ```My Snippet``` ````
and this is a method that Markdown uses to allow embedded backticks inside a code block. - Formatting: The
{{
}}
used to surround the snippet calls will unfortunately be formatted by a Markdown formatter and make the call invalid. Workarounds:- Decommentify: Put the snippet call inside a HTML comment, then use
decommentify
parameter. See ./snipinator/examples/LONG-EXAMPLE.md.jinja2 for examples. - prettier formatter is pretty good at leaving the Jinja2 calls alone, especially if you don't have any spaces. This especially helps for markdown "reference-style links" that have Jinja2 calls in them generating part of the URL, mdformat will URL encode the Jinja2 calls, and/or split them on spaces, which is not what we want. prettier will leave them alone.
- For code blocks: If you embed the snippet call in a code block, it will not be formatted. However, because of Embedded Backticks gotcha, (see above), this is not recommended, unless you know for sure that there are no embedded backticks.
- If your formatter supports a comment that disabled formatting, you can surround the snippet call with that comment.
- Decommentify: Put the snippet call inside a HTML comment, then use
- Editing the wrong file: When you have a template and a generated file, it is
easy to edit the wrong file. To combat this:
- Snipinator provides a warning at the top of the generated file to remind you that it is auto-generated.
- Snipinator will optionally chmod the file for you to make it read-only.
- Newlines: This program assumes LF newlines. I don't know if it will work for anything else.
- Combining
backtickify
andindent
: Doesn't make much sense, but if you do it, it will run backtickify first, then indent everything including the backticks.
🤏 Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
🔑 License
This project is licensed under the MIT License - see the ./LICENSE.md file for details.
🙏 Thanks
Main libraries used in Snipinator are:
- Templating: Jinja2.
- Snippet inclusion: Python's AST library.
- Colorful CLI help: rich-argparse.
- ANSI coloring shell output: {pexpect, rich}.
🤝 Related Projects
Not complete, and not necessarily up to date. Make a PR (contributions) to insert/modify.
Project | Stars | Last Update | Language | Platform | Similarity X Obviousness |
---|---|---|---|---|---|
mdx-js / mdx | 16.8k | 2024/04/17 |
JS | N/A | ⭐⭐⭐⭐⭐ |
fletcher / MultiMarkdown-6 | 599 | 2023/12/30 |
C | CLI | ⭐⭐⭐⭐⭐ |
gajus / gitdown | 448 | 2022/03/01 |
JS | CLI | ⭐⭐⭐⭐⭐ |
gpoore / codebraid | 362 | 2023/10/17 |
Python | CLI | ⭐⭐⭐⭐⭐ |
amyreese / markdown-pp (archived) | 307 | 2021/09/02 |
Python | CLI | ⭐⭐⭐⭐⭐ |
zakhenry / embedme | 222 | 2023/11/08 |
JS | CLI | ⭐⭐⭐⭐⭐ |
DCsunset / pandoc-include | 62 | 2024/04/30 |
Python | Pandoc / CLI | ⭐⭐⭐⭐⭐ |
BurdetteLamar / markdown_helper | 38 | 2020/03/16 |
Ruby | CLI | ⭐⭐⭐⭐⭐ |
SimonCropp / MarkdownSnippets | 23 | 2024/04/23 |
.NET | CLI | ⭐⭐⭐⭐⭐ |
endocode / snippetextractor | 4 | 2014/08/16 |
C++ | CLI | ⭐⭐⭐⭐⭐ |
polywrap / doc-snippets | 3 | 2023/09/26 |
JS | CLI | ⭐⭐⭐⭐⭐ |
hxtmike / markdown_include | 2 | 2024/05/09 |
Python | CLI | ⭐⭐⭐⭐⭐ |
JulianCataldo / remark-embed | 2 | 2022/09/22 |
JS | JS / library | ⭐⭐⭐⭐⭐ |
xrd / oreilly-snippets | 2 | 2015/10/15 |
Ruby | Ruby / library | ⭐⭐⭐⭐⭐ |
DamonOehlman / injectcode | 1 | 2021/08/01 |
JS | CLI | ⭐⭐⭐⭐⭐ |
electrovir / markdown-code-example-inserter | 1 | 2024/02/19 |
JS | CLI | ⭐⭐⭐⭐⭐ |
andersfischernielsen / Simple-Embedded-Markdown-Code-Snippets | 1 | 2021/02/12 |
JS | CLI | ⭐⭐⭐⭐⭐ |
ildar-shaimordanov / git-markdown-snippet | 0 | 2021/09/14 |
Perl | CLI | ⭐⭐⭐⭐⭐ |
marc-bouvier-graveyard / baldir_markdown | 0 | 2020/06/15 |
Python | CLI | ⭐⭐⭐⭐⭐ |
facelessuser / pymdown-extensions (snippets) | 903 | 2024/05/05 |
Python | Python / PyMarkdown | ⭐⭐⭐⭐ |
dineshsonachalam / markdown-autodocs | 176 | 2022/09/19 |
JS | GH Action | ⭐⭐⭐⭐ |
sethen / markdown-include | 148 | 2017/10/26 |
JS | CLI+config | ⭐⭐⭐⭐ |
cmacmackin / markdown-include | 95 | 2023/02/07 |
Python | Python / library | ⭐⭐⭐⭐ |
tokusumi / markdown-embed-code | 28 | 2022/01/05 |
Python | GH Action | ⭐⭐⭐⭐ |
sammndhr / gridsome-remark-embed-snippet | 2 | 2021/06/14 |
JS | Gridsome | ⭐⭐⭐⭐ |
NativeScript / markdown-snippet-injector | 4 | 2019/01/24 |
JS | CLI | ⭐⭐⭐⭐ |
fossunited/markdown-macros | 0 | 2021/06/10 |
Python | Python / Python-Markdown | ⭐⭐⭐⭐ |
fuxingloh / remark-code-import-replace | 0 | 2022/12/21 |
JS | Remark? | ⭐⭐⭐⭐ |
teyc / markdown-snippet | 0 | 2024/01/22 |
Powershell | Powershell / function | ⭐⭐⭐⭐ |
szkiba / mdcode | 15 | 2014/02/12 |
Go | CLI | ⭐⭐⭐ |
devincornell/pymddoc | 0 | 2023/12/01 |
Python | Python | ⭐⭐⭐ |
shiftkey / scribble (docs) | 40 | 2013/08/08 |
.NET | CLI | ⭐⭐ |
calebpeterson / jest-transformer-test-md | 2 | 2020/08/21 |
JS | Jest Tests | ⭐⭐ |
tjstankus / commitate | 0 | 2014/05/29 |
Ruby | CLI | ⭐ |
GitHub Docs: Creating a permanent link to a code snippet | N/A | N/A | N/A | GitHub | ⭐ |
javierfernandes / markdown-exercises | 1 | 2017/05/01 |
JS | N/A | ⭐ |
gatsby-remark-embed-snippet | N/A (55k) | 2024/01/23 |
JS | Gatsby | ⭐ |
ARMmbed / snippet (docs) | 6 | 2021/08/05 |
Python | CLI | ⭐ |
drewavis / markdowninclude | 1 | 2024/04/06 |
JS | VSCode Extension | ? |
romnn / embedme | 0 | 2024/04/18 |
Go | N/A | ⭐ |
🫡 Contributions
Development environment: Linux-like
-
For running
pre.sh
(Linux-like environment).-
From ./.github/dependencies.yml, which is used for the GH Action to do a fresh install of everything:
bash: scripts. findutils: scripts. grep: tests. xxd: tests. git: scripts, tests. xxhash: scripts (changeguard). rsync: out-of-directory test. expect: for `unbuffer`, useful to grab and compare ansi color symbols. jq: dependency for [yq](https://github.com/kislyuk/yq), which is used to generate the README; the README generator needs to use `tomlq` (which is a part of `yq`) to query `pyproject.toml`. unzip: scripts (pyenv). curl: scripts (pyenv). git-core: scripts (pyenv). gcc: scripts (pyenv). make: scripts (pyenv). zlib1g-dev: scripts (pyenv). libbz2-dev: scripts (pyenv). libreadline-dev: scripts (pyenv). libsqlite3-dev: scripts (pyenv). libssl-dev: scripts (pyenv). libffi-dev: bdist_wheel (otherwise `pip install .` fails). If installing pyenv, this must be installed _first_.
- On Ubuntu:
sudo apt-get update
and thensudo apt-get install -y bash findutils grep xxd git xxhash rsync expect jq unzip curl git-core gcc make zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev libssl-dev libffi-dev
.
- On Ubuntu:
-
Requires
pyenv
, or an exact matching version of python as in ./.python-version (which is currently3.8.0
). -
act (to run the GH Action locally):
- Requires nodejs.
- Requires Go.
- docker.
-
Generate animation:
- docker
-
docker (for building the docker image).
-
Commit Process
- (Optionally) Fork the
develop
branch. - Stage your files:
git add path/to/file.py
. bash ./scripts/pre.sh
, this will format, lint, and test the code.git status
check if anything changed (generated ./README.md for example), if so,git add
the changes, and go back to the previous step.git commit -m "..."
.- Make a PR to
develop
(or push to develop if you have the rights).
🔄🚀 Release Process
These instructions are for maintainers of the project.
- In the
develop
branch, runbash ./scripts/pre.sh
to ensure everything is in order. - In the
develop
branch, bump the version in ./pyproject.toml, following semantic versioning principles. Also modify thelast_release
andlast_stable_release
in the[tool.snipinator-project-metadata]
table as appropriate. Runbash ./scripts/pre.sh
to ensure everything is in order. - In the
develop
branch, commit these changes with a message like"Prepare release X.Y.Z"
. (See the contributions section above). - Merge the
develop
branch into themaster
branch:git checkout master && git merge develop --no-ff
. master
branch: Tag the release: Create a git tag for the release withgit tag -a vX.Y.Z -m "Version X.Y.Z"
.- Publish to PyPI: Publish the release to PyPI with
bash ./scripts/deploy-to-pypi.sh
. - Push to GitHub: Push the commit and tags to GitHub with
git push && git push --tags
. - The
--no-ff
option adds a commit to the master branch for the merge, so refork the develop branch from the master branch:git checkout develop && git merge master
. - Push the develop branch to GitHub:
git push origin develop
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for snipinator-3.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 838ec02c2c5d7b2128c813d7d37e914db7f5a7c368fc1dff1e1a6cbee73eb0bb |
|
MD5 | c8523baa8f20e24e151a4a01b420fc1a |
|
BLAKE2b-256 | 2c93fb42171692520846fc6750b8d19c217789372b23fe88f2b227c1818b3f3d |