Saravanan666/pypi-org huggingface dataset:
Package: pelican_publications
A plugin for thePelicanstatic website generator that
embeds a BibTeX publication list in a page or article
using apublicationsrestructured text directive.Usage:.. publications:: path/to/publications.bib
    :template: path/to/publications.html
    :sort: dateBy default pelican_publications uses apublicationstemplate
in the Pelican theme. This can be overridden by setting
the template option as a path to a Jinja2 template.
The template is passed one parameter,publications, which is
a list of BibTeX entries.
These BibTeX entries are simple dictionaries
in the format used by thebibtexparserPython package, with a few
customisations such as converting page ranges to use an html en dash
and splitting the author field into a list of authors.Possible sort options are:dateSort by publication date (this is the default).keySort by BibTeX key.nameSort by author names.
Package: pelican-qsb
Pelican Quick Site Builder (pelican-qsb)AboutScript can help to build local server or push site to GitHub. Have additional
sub-arguments.Attention!Use only in your virtual environment!
All "git push" actions are used with the--forceflag, so all commits will be rewritten.UsageRequirementsPelicanPython>= 3.6ghp-importGet start:Pre-requirements:Install and configurePelican-InstructionInstall script:From sources:Clone this repository using Git to your Pelican folder# Simple way to clone pelican-qsbgitclone--depth=1https://github.com/dmytrohoi/pelican-qsb.gitqsb&&rm-rf./qsb/.gitRun pelican-qsb script for the first time and configure it# NOTE: './qsb/' it's the PATH to pelican-qsb project dirpython./qsb/make_site.pyFrom pip:Install script from pip:pipinstallpelican-qsbRun pelican-qsb script in your Pelican directory for the first time and configure it:pelican-qsbFunctions:github[-d][-b]# make gh-output and push it to github repository# (without [d]raft and [b]ackup as default)local# make local server using pelicanconf.py filebackup# backup all files in your Pelican directory to backup repository-h,--help# print help infoCreated by Dmytro Hoi, 2019
Package: pelican-read-more
Read More: A Plugin for PelicanThis Pelican plugin inserts an inline “Read More” link into the last HTML element of the summary.For more information regarding why it was created, please visit:https://www.vuongnguyen.com/read-more-python-lxml/InstallationThis plugin can be installed via:python -m pip install pelican-read-moreSettingsThe following settings are available. If not set, the plugin will use default values.The following setting defines the string that is added to the end of the summary, before the “Read More” link:SUMMARY_END_SUFFIX = "..."The following setting defines the summary length before truncating and adding the “Read More” link:SUMMARY_MAX_LENGTH = 50The following setting defines the “Read More” link text:READ_MORE_LINK = '<span>continue</span>'The following setting defines the format of the “Read More” link:READ_MORE_LINK_FORMAT = '<a class="read-more" href="/{url}">{text}</a>'ContributingContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting onexisting issues.To start contributing to this plugin, review theContributing to Pelicandocumentation, beginning with theContributing Codesection.ContributorsContributors include:Vuong Nguyen, Dashie,Justin Mayer, KerncLicenseThis project is licensed under the AGPL 3.0 license.
Package: pelican-readtime
Plugin forPelicanthat computes a piece of content’s read time.It adds areadtimeandreadtime_stringattributes to every
article and/or page, with the time estimation for reading the article.Setting UpAdding ‘ReadTime’ to the list of plugins:In pelicanconf.py:PLUGINS=[...,'readtime']1. Words Per Minute OnlyIn your settings you would use assign theREADTIME_WPMvariable to
an integer like so:In pelicanconf.py:READTIME_WPM=180Every article’s read time would be calculated using this average words
per minute count. (See the Usage section for how to use the calculated
read times in templates). This is the simplest read time method.2. Words Per Minute per languageThis is the preferred method if you are dealing with multiple languages.
Take a look at the following settingsIn pelicanconf.py:READTIME_WPM={'default':{'wpm':200,'min_singular':'minute','min_plural':'minutes','sec_singular':'second','sec_plural':'seconds'},'es':{'wpm':220,'min_singular':'minuto','min_plural':'minutos','sec_singular':'segundo','sec_plural':'segundos'}}In this example the default reading time for all articles is 200 words
per minute. Any articles in spanish will be calculated at 220 wpm. This
is useful for information dense languages where the read time varies
rapidly.Chances are the average reading time will not vary rapidly from language
to language, however using this method also allows you to set plurals
which make templating easier in the long run.UsageFour variables are accessible through the read time plugin:readtime,readtime_string,readtime_with_seconds, andreadtime_string_with_seconds{% if article.readtime %} This article takes {{article.readtime}} minute(s) to read.{% endif %}
// This article takes 4 minute(s) to read.{% if article.readtime_string %} This article takes {{article.readtime_string}} to read.{% endif %}
// This article takes 4 minutes to read.{% if article.readtime_with_seconds %}
  This article takes {{article.read_with_seconds[0]}} minutes(s) and {{article.read_with_seconds[1]}} second(s) to read.
{% endif %}
// This article takes 4 minutes and 21 second(s) to read.{% if article.readtime_string_with_seconds %} This article takes {{article.readtime_string_with_seconds}} to read.{% endif %}
// This article takes 4 minutes, 1 second to read.Links
Package: pelican-redirect
Pelican Redirect: A Plugin for PelicanRedirect pages using meta http-equiv tagsInstallationThis plugin can be installed via:python-mpipinstallpelican-redirectUsageOnce this plugin is installed, you can add a key to the frontmatter of the file calledoriginal_url. The plugin will generate an HTML page at that location that redirects to the new location of the post/page. Example:Title: A sample title
original_url: blog-posts/2021/07/21/a-sample-title.html

Content hereAssuming this file is now going to be served fromblog-posts/a-simple-title.html, a file will be written toblog-posts/2021/07/21/a-sample-title.htmlthat redirects to the new URL.sContributingContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting onexisting issues.To start contributing to this plugin, review theContributing to Pelicandocumentation, beginning with theContributing Codesection.LicenseThis project is licensed under the BSD-3-Clause license.
Package: pelican-redirect-url
URL Redirection Plugin for PelicanPelican plugin for redirecting to URLs.This Pelican plugin allows you to generate pages which redirect to any URL, using plain HTML.InstallationThe package is available on PyPI and can be installed usingpip install pelican-redirect-url.Alternatively, you may want to install it straight from a source checkout:python -m pip install .UsageInclude the plugin by adding it to yourpelicanconf.pyand add theredirect_urldirective to the metadata block of the corresponding page:redirect_url: https://github.comCreditsThis plugin draws some inspiration from thepelican-redirectplugin by Bryan Weber. Nevertheless, the target usage of both plugins differs, and so does the implementation.
Package: pelican-references
references: A Plugin for PelicanGenerate bibliographies from BibTeX filesInstallationThis plugin can be installed via:python -m pip install pelican-referencesUsage<>ContributingContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting onexisting issues.To start contributing to this plugin, review theContributing to Pelicandocumentation, beginning with theContributing Codesection.LicenseThis project is licensed under the AGPL-3.0 license.
Package: pelican_related
InstallationThis plugin is not registered on PyPI. You should clone this repository and install through pip:git clone git@github.com:wutali/pelican_related.git
cd pelican_related
pip install -e .ConfigurationPut this code on your pelicanconf.py and customize it:RELATED_POSTS_MIN = 3 # Minimum number of posts to be shown.
RELATED_POSTS_LIMIT = 6 # Limit number of posts to be shown.
RELATED_POSTS_FROM_CATEGORY = True # Weight related posts based on category.
RELATED_POSTS_FROM_TAGS = True # Weight related posts based on tags.
RELATED_POSTS_SHUFFLE = True # Shuffle posts before show it.

# If number of related posts is not up to the minimum, add some articles based on this setting.
# You can choose the option from 'shuffle' or 'new'.
RELATED_POSTS_NOT_ENOUGH = 'shuffle'LicensePelican Related is released under the MIT License.http://www.opensource.org/licenses/mit-license
Package: pelican-related-posts
Related Posts: A Plugin for PelicanRelated Posts is a Pelican plugin that adds a list of related posts to an article by adding arelated_postsvariable to the article’s context.InstallationThis plugin can be installed via:python -m pip install pelican-related-postsUsageBy default, up to five related articles are listed. You can customize this value by definingRELATED_POSTS_MAXin your settings file:RELATED_POSTS_MAX = 10You can then use thearticle.related_postsvariable in your templates. For example:{% if article.related_posts %}
    <ul>
    {% for related_post in article.related_posts %}
        <li><a href="{{ SITEURL }}/{{ related_post.url }}">{{ related_post.title }}</a></li>
    {% endfor %}
    </ul>
{% endif %}Your related posts should share a common tag. You can also userelated_posts:in your post’s meta-data. Therelated_posts:meta-data works together with your existing slugs:related_posts: slug1, slug2, slug3, ... slugNNrepresents theRELATED_POSTS_MAXvalue.Additionally, you can specify the following in your settings file:RELATED_POSTS_SKIP_SAME_CATEGORY = TrueWith this setting,article.related_postswill contain only related posts from categories other than the original article's.ContributingContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting onexisting issues.To start contributing to this plugin, review theContributing to Pelicandocumentation, beginning with theContributing Codesection.
Package: pelican-resume
Introduction============[![Build Status](https://travis-ci.org/cmenguy/pelican-resume.svg?branch=master)](https://travis-ci.org/cmenguy/pelican-resume)This is **pelican_resume**, a Pelican plugin enabling automatic PDF resume generation for one of your Pelican pages.The main benefit is that you only need to maintain a single Markdown version of your resume - the correspondingHTML and generated PDF are completely automated so you can showoff your awesome resume both online and physically.It allows you write your own resume style, or use one of the styles provided by this plugin.Installation============Installing is easy, simply run:pip install pelican-resumeAlternatively, you can also clone this repository and install it manually:git clone git@github.com:cmenguy/pelican-resume.gitpython setup.py installIn **pelicanconf.py** you need to update your plugins to inclue **pelican_resume**:PLUGINS = [# ..."pelican_resume",# ...]Settings========You can customize the behavior of the plugin by adding the variables below to your **pelicanconf.py**.For simple usage, the default values should work but will look for a specific input file and produce a specific PDF name.Setting name | Default value | Usage--- | --- | ---`RESUME_SRC` | pages/resume.md | Path to your Markdown resume page (relative to your `PATH` variable).`RESUME_PDF` | pdfs/resume.pdf | Path to the generated PDF output (relative to your `OUTPUT_PATH` variable).`RESUME_CSS_DIR` | *<module-install-path>/static/css* | Path to the directory containing your resume CSS files.`RESUME_TYPE` | moderncv | Type of resume to use. Has to match one of the CSS filenames under `RESUME_CSS_DIR`.`RESUME_PANDOC` | pandoc | Path to your `pandoc` command. If `pandoc` is in your `PATH`, then it can be left as default.`RESUME_WKHTMLTOPDF` | wkhtmltopdf | Path to your `wkhtmltopdf` command. If `wkhtmltopdf` is in your `PATH`, then it can be left as default.Usage=====Once you have the plugin properly configured, it will generate a PDF version of your resume automatically under the`RESUME_PDF` location everytime you run `pelican content`.It can then easily be embedded into your Pelican website by referencing that location - thus ensuring your visitorscan download the latest version of your resume which is consistent with your Markdown file.Contributing============[Contributing Guidelines](CONTRIBUTING.md)
Package: pelican-series-plugin
Pelican Series: A Plugin for PelicanThis plugin extends the original series plugin byFELD Borislothiraldan@gmail.comCopyright (c)Leonardo Giordanigiordani.leonardo@gmail.comThis plugin is also in thePelican Plugins repositoryThe series plugin allows you to join different posts into a series.In order to mark posts as part of a series, use the:series:metadata::series:  NAME_OF_THIS_SERIESor, in Markdown syntaxSeries: NAME_OF_THIS_SERIESThe plugin collects all articles belonging to the same series and provides
series-related variables that you can use in your template.IndexingBy default articles in a series are ordered by date and then automatically numbered.If you want to force a given order just specify the:series_index:metadata or in Markdownseries_index:,
starting from 1. All articles with this enforced index are put at the beginning of
the series and ordered according to the index itself. All the remaining articles
come after them, ordered by date.The plugin provides the following variables to your templates* `article.series.name` is the name of the series as specified in the article metadata
* `article.series.index` is the index of the current article inside the series
* `article.series.all` is an ordered list of all articles in the series (including the current one)
* `article.series.all_previous` is an ordered list of the articles published before the current one
* `article.series.all_next` is an ordered list of the articles published after the current one
* `article.series.previous` is the previous article in the series (a shortcut to `article.series.all_previous[-1]`)
* `article.series.next` is the next article in the series (a shortcut to `article.series.all_next[0]`)
* `article.series.first` is the first article in the series
* `article.series.last` is the last article in the seriesFor example:{% if article.series %}
    <p>This post is part {{ article.series.index }} of the "{{ article.series.name }}" series:</p>
    <ol class="parts">
        {% for part_article in article.series.all %}
            <li {% if part_article == article %}class="active"{% endif %}>
                <a href='{{ SITEURL }}/{{ part_article.url }}'>{{ part_article.title }}</a>
            </li>
        {% endfor %}
    </ol>
{% endif %}Joins articles in a series and provides variables to manage the series in the template.InstallationThis plugin can be installed via:pip install pelican-series-pluginNext add it to thePLUGINSsection inpelicanconf.pyPLUGINS=['...','pelican.plugins.series','...']ContributingContributions are welcome and much appreciated. Every little bit helps.
You can contribute by improving the documentation, adding missing features, and fixing bugs.
You can also help out by reviewing and commenting onexisting issues.To start contributing to this plugin, review theContributing to Pelicandocumentation, beginning with theContributing Codesection.
Package: pelican-share-post
Share Post: A Plugin for PelicanShare Post is a Pelican plugin that creates share links in articles that allow site visitors to share the current article with others in a privacy-friendly manner.Many web sites have share widgets to let readers share posts on social networks. Most of these widgets are used by vendors for online tracking. These widgets can also be visually-distracting and negatively affect readers’ attention.Share Post creates old-school URLs for some popular sites which your theme can use. These links do not have the ability to track site visitors. They can also be unobtrusive depending on how Pelican theme uses them.InstallationThis plugin can be installed via:python -m pip install pelican-share-postUsageThis plugin adds to each Pelican article a dictionary of URLs that, when followed, allows the reader to easily share the article via specific channels. When activated, the plugin adds the attributeshare_postto each article with the following format:article.share_post={"email":"<URL>","diaspora":"<URL>","facebook":"<URL>","hacker-news":"<URL>","linkedin":"<URL>","mastodon":"<URL>","reddit":"<URL>","twitter":"<URL>",}You can then access those variables in your template. For example:{%ifarticle.share_postandarticle.status!='draft'%}<section><pid="post-share-links">Share on:<ahref="{{article.share_post['email']}}"title="Share via Email">Email</a>❄<ahref="{{article.share_post['diaspora']}}"title="Share on Diaspora">Diaspora</a>❄<ahref="{{article.share_post['facebook']}}"title="Share on Facebook">Facebook</a>❄<ahref="{{article.share_post['hacker-news']}}"title="Share on Hacker News">Hacker News</a>❄<ahref="{{article.share_post['linkedin']}}"title="Share on LinkedIn">LinkedIn</a>❄<ahref="{{article.share_post['mastodon]}}" title="Share on Mastodon">Mastodon</a>❄<a href="{{article.share_post['reddit']}}" title="Share via Reddit">Reddit</a>❄<a href="{{article.share_post['twitter']}}"title="Share on Twitter">Twitter</a></p></section>{%endif%}ContributingContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting onexisting issues.To start contributing to this plugin, review theContributing to Pelicandocumentation, beginning with theContributing Codesection.ContributorsTalha Mansoor-talha131@gmail.comJonathan DEKHTIAR-contact@jonathandekhtiar.euJustin MayerLeonardo GiordaniMaurizio PagliaLicenseThis project is licensed under the MIT license.
Package: pelican-shiori
pelican-shioriis a port of theShioritheme (originally built for
Jekyll byElle Kasai) toPelican.Installation$pipinstallpelican-shioriRequirementsassetsplugin for PelicanworkingSASScompilerUsageIn your pelicansettings.py, set theTHEMEandASSET_CONFIGvariables like the following -importpelican_shioriTHEME=pelican_shiori.path()ASSET_CONFIG=pelican_shiori.asset_config()ConfigurationThe following configuration variables are supported.SHIORI_AVATAR_URL: URL of the avatar you’d like to show on the sidebarSHIORI_HIDE_SIDEBAR: whether or not to show the sidebarSHIORI_INDEX_ARTICLES_COUNT: number of articles to show on the index pageSHIORI_THEME: which color scheme to use (one ofdark,turquoise,green,blue,purple,orange,red)Color SchemesThis theme is available in multiple color schemes (based onFlat UI Colors).
The default value for the color scheme is set to (surprise)default. To
change it to one of the supported values, adjust theSHIORI_THEMEandASSET_CONFIGvariables as follows -SHIORI_THEME='blue'ASSET_CONFIG=pelican_shiori.asset_config(SHIORI_THEME)Please make sure that the argument given topelican_shiori.asset_configis the same asSHIORI_THEME.Bad thingsmay happen otherwise.
Package: pelican-similar-articles-light
Similar articles for PelicanA Pelican plugin to provide a support of similar articles, allowing users to
access a list of articles linked to each article by a similarity calculation
on their tags.Installationpip install pelican-similar-articles-light

# Or locally
python setup.py developTemplate integrationBare version:{% if article.similar_articles %}<ul>{% for sub_article in article.similar_articles %}<li><ahref="{{ SITEURL }}/{{ sub_article.url }}">{{ sub_article.title }}</a></li>{% endfor %}</ul>{% endif %}With bootstrap and translations support:{% if article.similar_articles %}<divclass="alert alert-warning text-left"role="alert"><p><strong>{{ _("You might be interested in") ~ ' ' ~ ngettext("the following article:", "the following articles:", article.similar_articles|count) }}</strong></p><ul>{% for sub_article in article.similar_articles %}<li><ahref="{{ SITEURL }}/{{ sub_article.url }}"class="alert-link">{{ sub_article.title }}</a></li>{% endfor %}</ul></div>{% endif %}Pelican configurationIn yourpelicanconf.py, please add/update these lines:PLUGINS+=['pelican.plugins.similar_articles_light',]You you can customize certain features of the plugin.
You will find below the default values which can be overwritten by a statement
in thepelicanconf.pyfile.The maximum number of similar articles:SIMILAR_ARTICLES_MAX_COUNT=2The the minimal score to consider an article as similar:SIMILAR_ARTICLES_MIN_SCORE=0.0001About the implementationThe plugin computes a similarity score based on the tags of the articles.
It consists in building a global bag of words (dictionary), and a bag of words
for each article, representing this article as an n-dimensional vector.The terms are weighted using theTF-IDF method,
according to their rareness within the corpus formed by all the tags of the site.The vector of each article is then compared to all the others via the calculation
of thecosine simiaritywidely used in text mining. It consists in determining the angle formed between
2 vectors.
The maximum similarity obtained is 1 (the documents have all their important tags
in common), while the minimum is 0 (the documents have no tag in common).Comparison withSimilar PostspluginTheSimilar Posts pluginuses exactly the same technique, I don't think you will have any difference in the
the result obtained.
However, the dependencies used are a bit too large and somewhat oversized for
the intended purpose: a few words (tags) summarizing an article among a handful
of articles from a Pelican blog.The implementation of Similar Articles Light is in pure Python.In any case, reinventing the wheel should never be a reason to sell a technology;
therefore please consider this plugin as a proof of concept of a few dozen lines of code,
fully functional and without dependencies; so probably slightly faster to run
thanSimilar Posts.
Package: pelican-simple-footnotes
Simple FootnotesSimple Footnotes is a Pelican plugin for adding footnotes to articles and pages.InstallationThis plugin, and its dependent packagehtml5lib, can be installed via:python -m pip install pelican-simple-footnotesUsageWhen writing an article or page, add a footnote like this:Here’s my written text[ref]and here is a footnote[/ref].This will appear as, roughly:Here’s my written text1and here is a footnote ↩This should work with any content format (reST, Markdown, et cetera), because
it looks for[ref]and[/ref]once the conversion to HTML has happened.ContributingContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting onexisting issues.To start contributing to this plugin, review theContributing to Pelicandocumentation, beginning with theContributing Codesection.CreditsOriginally authored byStuart Langridge, February 2014,
and subsequently enhanced by members of the Pelican community, includingJustin Mayer, who re-packaged it for publication to
PyPI.Inspired by Andrew Nacin’sSimple Footnotes WordPress plugin.