Saravanan666/pypi-org huggingface dataset:
Package: pelican-cite-nice
pelican-cite-nicePelican cite plugin modified to work with nice-blog themeAllows the use of BibTeX citations within a Pelican site.Requirementspelican-citerequirespybtex.pipinstallpybtexHow to UseThis plugin reads a user-specified BibTeX file and generates bibliographic
information within your articles and pages.Configuration is simply:PUBLICATIONS_SRC='content/pubs.bib'If the file is present and readable, then content will be scanned for references
to citation keys. These take the format[@Bai2011]or[@@Bai2011]. These
will be replaced by incline citations which provide links to the full
bibliographic information at the end of the article. The former reference would
be replaced by a citation of the form "Bai & Stone (2011)", while the latter
would be replaced by "(Bai & Stone, 2011)".If a citation key is used which does not exist within the BibTeX file then
a warning will be displayed.The BibTeX file may, optionally, be provided or overridden on a per-article
basis by supplying the meta-datapublications_src.Attributionpelican-cite-niceis based on thepelican-citeplugin written byChris MacMackin.
Package: pelican-comment-system
Pelican Comment SystemPelican Comment System allows you to add static comments to your
articles.Comments are stored in files in formats that can be processed by Pelican
(e.g., Markdown, reStructuredText). Each comment resides in its own
file.FeaturesStatic comments for each articleReplies to commentsAvatars andIdenticonsComment Atom feed for each articleEasy styleable via themesPython 2 and 3 supportSee it in action here:bernhard.scheirle.deAuthorWebsiteGithubBernhard Scheirlehttp://bernhard.scheirle.dehttps://github.com/ScheirleInstructionsQuickstart GuideInstallation and basic usageImport existing commentsAvatars and identiconsComment Atom feed[Developer] How to do a releasePyPiThe Pelican Comment System is now also in the Python Package Index and can easily installed via:pip install pelican_comment_systemRequirementsPelican 3.4 or newer is required.To create identicons, the Python Image Library is needed. Therefore you
either need PILorPillow (recommended).Install Pillow via:pip install PillowIf you don’t want avatars or identicons, this plugin works fine without
PIL/Pillow. You will, however, see a warning that identicons are
deactivated (as expected).Change LogThe change log can be found in theCHANGELOG.rstfile.Change LogAll notable changes to this project will be documented in this file.
This project adheres toSemantic Versioning.1.4.0 – 2017-02-20Addedaddsetup.pyto allow posting plugin to PyPIPR
#8621.3.0 – 2017-01-10Addedaddblogger_comment_export.pyscript to export comments from Blogger XML export andassociated
documentationPR
#8351.2.2 – 2016-12-19FixedCorrect jQuery expression in cancelReply methodPR
#8201.2.1 – 2016-09-22FixedAdd support for the autoreload mode of pelicanPR
#782Fixes
pelican#19491.2.0 – 2016-05-23Fixed - DocumentationCorrect template pathPR
#713Added - DocumentationAdds Quickstart guide + default themePR
#686FixedFix mailto link: use ‘’ instead of ‘’PR
#720Fix comparison of offset-naive and offset-aware datetimesPR
#722AddedLogs a warning if the parent of a comment can not be foundPR
#7151.1.0 – 2016-02-18Fixed – DocumentationUpdated old URLsPR
#677ChangedMain logic runs a bit earlier (allows other plugins to access
comments earlier)PR
#677The writer to generate the feeds can now be exchanged (via a normal
pelican writer plugin)PR
#6771.0.1 – 2015-10-04Fixed – DocumentationAdd commas indicating tuple (PELICAN_COMMENT_SYSTEM_AUTHORS)PR
#5791.0.0 – 2014-11-05AddedBasic static commentsAtom FeedsReplies to commentsAvatars and identiconsThis change log usesKeep a CHANGELOGas a template.
Package: pelican-data
# pelican-dataData and collections management for PelicanThis extension allow to load data from any reader plus yaml and json files.
It also allows free custom pages layouts.# Changelog## In developmentNothing yet## 0.2.0 (2020-03-18)Fix theYAMLLoadWarningraised du the deprecatedyaml.load()usage## 0.1.0 (2020-03-14)Initial release (raw extract from a pelican project, still needs ❤)
Package: pelican-decorate-content
pelican-decorate-contentA Pelican plugin for rule-based addition of classes to your content. This can be useful when you use a functional CSS toolset (e.g. Tachyons) to style your site and do not want to write custom CSS targeting your content.InstallationInstall from PyPi:pip install pelican_decorate_contentUsageIn yourpelicanconf.pyimport the plugin and add it toPLUGINS:frompelican_decorate_contentimportdecorate_content# ...PLUGINS=[decorate_content]ConfigurationGlobal settingsGlobal configuration happens in aDECORATE_CONTENTsetting, which is a dict that maps CSS selectors to a list of classes that will be added to each match:DECORATE_CONTENT={'h1':['f2','normal','lh-title','mt3','ma0','mb3'],'h2':['f25','normal','lh-title','mt4','ma0','mb3'],'h3':['f5','normal','mt5','ma0','mb3'],'h4':['f5','normal','mt4','ma0','mb1'],'h5':['f5','normal','mt2','ma0','mb1'],'h6':['f5','lh-solid','normal','ma0','light-silver'],}Overrides on article or page levelOverrides for these global defaults can be added in your article or page's front matter by defining a JSON string asdecorate_content:decorate_content:'{"h1":["f3","bold"]}'# this overrides the entire keyLicenseCopyright 2020 Frederik Ring - Available under the MIT License
Package: pelican-delicious
Pelican Delicious Bookmarks is a library to make it easy to add your Delicious bookmarks in yourPelicanblogs.InstallationTo install pelican-delicious, simply:$pipinstallpelican-deliciousThen add a bit of code to your blog configuration:PLUGINS=[# ...'pelican_delicious',# ...]UsageIn your articles, just add lines to your posts that look like:[delicious:tags=tag1 tage2]This will tell the plugin to insert links withs tag1 and tag2 into your post. The resulting HTML will look like:<divclass="delicious"><dl><dt>Title</dt><dd>The Titile of the link</dd><dt>Description</dt><dd>The Description</dd><dt>URL</dt><dd><ahref="http://www.example.com"/></dd></dl></div>SettingsCreate the file pelican-creds.py with your credentials :DELICIOUS_USERNAME='Your Delicious username'DELICIOUS_PASSWORD='Your Delicious password'Import this config in your pelicanconf.py :importpelican-deliciousfrompelican-deliciousimport*You can also modify the default template:DELICIOUS_TEMPLATE = """<divclass="delicious">{% for bookmark in bookmarks %}<dl><dt>Title</dt><dd>{{ bookmark.title }}</dd>{% if bookmark.description %}<dt>Description</dt><dd>{{ bookmark.description }}</dd>{% endif %}<dt>URL</dt><dd><ahref="{{ bookmark.url }}"/></dd></dl>{% endfor %}</div>"""Don’t forget to add pelican-creds.py to your .gitignore!LicenseUses theBEER-WARElicense.
Package: pelican-diminuendo
This Pelican plugin usespython-diminuendoto minify HTML.Install$pipinstallpelican-diminuendoUsageTo use the plugin, add it to the PLUGINS list in your configuration file. Put it in pelicanconf.py by default:PLUGINS=[# ...'pelican-diminuendo',]DevelopmentTestTest the package:$python-munittestdiscoverAutomatic testing in various environments:$toxReleaseUsebumprto release the package:$bumpr-b-mProjectSource code on githubDocumentation on readthedocsPackage on pypiLicensepelican-diminuendo is published under a BSD 3-clause license, see the LICENSE
file distributed with the project.
Package: pelican-drafts
Pelican DraftsAdd a browsable drafts listing fr your Pelican websiteRequirementsPelican Drafts works with Pelican 4.2+ and Python 3.7+Getting startedInstallpelican-draftswith pip:pipinstallpelican-draftsAnd enable the plugin in youpelicanconf.py(or any configuration file you want to use):PLUGINS=['...','drafts','...',]SettingsSHOW_DRAFTSWether or not to show the drafts page (default:True, set it toFalsein yourpublishconf.py)DRAFTS_URLURL on which you can consult the drafts page (default:'drafts/')DRAFTS_SAVE_ASPath to save the drafts page. It should be consistent with theDRAFTS_URLsetting (default:'drafts/index.html')ThemingChangelog0.1.1 (2020-03-26)Fix theSHOW_DRAFTSparameter being ignored0.1.0 (2020-03-26)Nothing Initial release
Package: pelican-edit-url
# pelican-edit-urlPelican plugin to add an edit URL to content objects.This plugin assumes that the parent directory of your
content directory is your project directory. If you have
the code for your site somewhere public (e.g. Github), you
can provide links to the source for each piece of content.## Installation` pip installpelican-edit-url`Add the setting to yourpelicanconf.py` EDIT_CONTENT_URL ='https://github.com/ME/MYCOOLSITE.com/blob/master/{file_path}'`Put{file_path}wherever the path to the file should go in the url. Once this is done
you will have anedit_urlproperty on your page and article objects.` <ahref="{{article.edit_url}}">editongithub</a>`
Package: pelican-email-cloak
E-mail Cloak: A Plugin for PelicanE-mail cloaking plugin for PelicanInstallationThis plugin can be installed via:python -m pip install pelican-email-cloakUsageTo use this plugin, add the following to yourpelicanconf.py:PLUGINS=[# ...'email_cloak',# ...]Pelican should automatically discover the plugin after installation under the namespacepelican.plugins.E-mails in articles and pages will be cloaked.Changelog0.1.0 up to 0.1.2: Added support for custom e-mail body and link caption & subsequent hotfixes0.0.1 up to 0.0.3: Initial releaseVersion bumped to update PyPI descriptionLicenseThis project is licensed under the MIT license.
Package: pelican-embedly
embed.ly cards for Pelican blog, version 0.2.0Free software: BSD licenseInstallationpip install pelican-embedlyDocumentationhttps://python-pelican_embedly.readthedocs.io/DevelopmentTo run the all tests run:toxNote, to combine the coverage data from all the tox environments run:Windowsset PYTEST_ADDOPTS=--cov-append
toxOtherPYTEST_ADDOPTS=--cov-append toxChangelog0.1.0 (2017-07-23)First release on PyPI.
Package: pelican-embed-microblog
Embedding tweets into your Pelican blog posts. This repo is an advance
version of the plugin fromlqezwhich hasn’t the
config for the style.Author   | Chris RoseHomepagehttps://offby1.websiteGithubhttps://github.com/offbyoneMastodonhttps://wandering.shop/@offby1How to enable itInstall the plugin withpip installpelican-embed-microblogPutpelican_embed_microbloginto plugin list of settings.PLUGINS = ['pelican_embed_microblog']Add your config into thepelicanconf.pyConfigThe config implement theTwitter
Api.Config
LabelDescriptionTWITTER_CARDSWhen set tohidden, links in a Tweet are not expanded to
photo, video, or link previews.TWITTER_THEMEWhen set tonone, only the cited Tweet will be displayed
even if it is in reply to another Tweet.TWITTER_CONVERS
ATIONWhen set todark, displays Tweet with light text over a
dark background.TWITTER_LINK_C
OLORAdjust the color of Tweet links with a hexadecimal color value.TWITTER_WIDTHThe maximum width of the rendered Tweet in whole pixels. This
value should be between 250 and 550 pixels.TWITTER_ALIGNFloat the Tweetleft,right, orcenterrelative to
its container. Typically set to allow text or other content to
wrap around the Tweet.TWITTER_LANGA supported Twitter language code. Loads text components in the
specified language. Note: does not affect the text of the cited
Tweet.TWITTER_DNTWhen set to true, the Tweet and its embedded page on your site
are not used for purposes that include personalized suggestions
and personalized ads.UsageWhen writing a post, you can use any of the following notations to link to microblogging content:UsernamesBoth Mastodon and Twitter usernames are supported. Any instance of “@username@host.name” will be replaced with a link to the appropriate instances’ user account page, and any instance of “@username” will be replaced with a link to the twitter account page for the user.Twitter statusesTo link a Twitter status, you write “@username/status/<numeric-tweet-id>”; essentially, you take the Twitter link itself and you replace “https://twitter.com/” with “@”AcknowledgmentsThanks tolqezfor the
original, and tofundor333who forked the
original embed tweet plugin, on which this is based.
Package: pelican-embed-svg
pelican-embed-svgPelicanplugin for embedding SVG images/icons at generation time. The plugin currently supports FontAwesome 5 icons specified using<i>tags as well as arbitrary SVG image files.Copyright (c) 2020 by Kevin HoulihanLicense: MIT, see LICENSE for more details.InstallationThe plugin can be installed from PyPI:pipinstallpelican-embed-svgTo enable the plugin, add it to thePLUGINSlist in your pelicanconf.pyPLUGINS=['pelican_embed_svg',]If you want to useFontAwesomeicons then you will need todownloadthat as well. It is recommended to install that to a directory namedfont-awesomein the root of your pelican site. However, if you want to use FontAwesome's css (for sizing, etc.), then those files will need to be included in your site's static content, and referenced appropriately in your templates.UsageSVG images to embed can be specified in three ways in your templates.FontAwsome<i>tags<i>tags with base FontAwesome classes (fas,fabetc.) and an additional class specifying the icon.<iclass="fas fa-heart"></i>All the classes specified will be copied to the embedded<svg>element in the output.Custom<i>tags<i>tags with the classpi, and an additional class specifying the name of the icon.<iclass="pi my-heart"></i>This will embed the first file named my-heart.svg that is found in your project output, or the svg icon path, if set (see the settings section below).All the classes specified will be copied to the embedded<svg>element in the output.<img>tags<img>tags withsrcattributes that specify svg files.<imgsrc="http://localhost:8000/images/my-heart.svg">The svg file in this case will be found by stripping out theSITEURL. As such, the file must be present in the project output.SettingsFontAwesome pathBy default, FontAwesome icons are looked for in a directory calledfont-awesomein the root of your pelican project. If you have FontAwesome installed somewhere else then you can specify the path by adding thePES_FONT_AWESOME_PATHsetting to your pelicanconf.py.SVG icon pathWhen specifying icons using<i>tags and thepiclass, by default the output directory is searched for the first svg file that matches. However, it is not strictly necessary for the svg files to be included in the output, so if you have them stored somewhere else the path can be specified using thePES_SVG_ICON_PATHsetting.<img>embeddingIf you don't want to process<img>tags then that can be turned off using thePES_EMBED_IMG_TAGSsetting:PES_EMBED_IMG_TAGS=FalsePath fillsBy default, the embedded svg paths have theirfillattribute set tocurrentColorfor<i>tags so that the image colours can be controlled using csscolorproperties. If this is not desirable (such as if your svgs have their own colour information), this can be turned off using thePES_SET_ICON_FILLsetting.For<img>tags, the fill is not modified by default. If you want the fill to be set for these then you can enable it using thePES_SET_IMG_FILLsetting.CaveatsThis plugin is at an early stage of development, and largely untested outside of my own personal use-case.
Package: pelican-export
pelican-exportpelican-export is a plugin into pelican that handles exporting of
posts from pelican to other formats. Currently the following formats
are supported:WordpressInstallationpelican-export requires python3.7 or above.pip install pelican-exportUsageAs with any pelican plugin, the plugin should be included in the PLUGINS global
variable in your pelicanconf.py. In addition, you should configure the exporter
using the configure_exporter method exposed. Here's an example with WordPress:# declare the plugin for pelican
PLUGINS = ["pelican-export"]

# configure the pelican_export itself
from pelican_export import configure_exporter

configure_exporter(export_type="wordpress", export_configuration={
    "url": "http://example.com/xmlrpc.php", 
    "username": "foo", 
    "password": "bar",
})Authoring an ExporterSeethe exporterfor the interface, andthe initialization codefor how to integrate it as an option.
Package: pelican-extended-sitemap
A sitemap plugin forPelican.It generates a sitemap.xml according to the specification ofsitemaps.organd considers the pelican index page, articles, pages and special pages (like tags, categories, authors).
Also comes with a XML stylesheet to be able to view the sitemap in browser without pain.There is also asitemap pluginwithin the official pelican plugin repo. The main differences in my package are:the overview pages for tags, pages aso are includedthere is a stylesheetused dates do not include timeNOTICE: Backwards incompatible changes in 1.0.0:In version 1.0.0 the package naming has been fixed, it’s now called “extended_sitemap” (instead “extended-sitemap”) following PEP8.
Please adjust your usages inPLUGINSappropriately.Sources and StatusGithub:https://github.com/dArignac/pelican-extended-sitemapPyPI:https://pypi.python.org/pypi/pelican-extended-sitemapPelican settingsAdd to the plugins list:PLUGINS=['extended_sitemap']Plugin settingsAdd theEXTENDED_SITEMAP_PLUGINdict to your settings.
The keys explained:priorities: priority for each page type, from 0.0 to 1.0index: index pagearticles: article pagespages: pagesothers: category, tags and authors pageschangefrequencies: how often a page will likely change, possible values: always, hourly, daily, weekly, monthly, yearly, neverThe settings below are the default values:EXTENDED_SITEMAP_PLUGIN={'priorities':{'index':1.0,'articles':0.8,'pages':0.5,'others':0.4},'changefrequencies':{'index':'daily','articles':'weekly','pages':'monthly','others':'monthly',}}Paths for DIRECT_TEMPLATESThe value of the paths forDIRECT_TEMPLATESare defined by the following order:({NAME}stands for the direct template name, e.g.ARCHIVESfor archives.)if the setting{NAME}_URLis defined, use{NAME}_URLif the setting{NAME}_URLis not defined but the setting{NAME}_SAVE_ASis, use{NAME}_SAVE_ASif none of the above applies, use the default filename{NAME}.htmlNote that{NAME}_URLis not a default Pelican setting.Testsnoseis required to run the tests. Install the package and run with thenosetestcommand.The tests fixture files were created with generated content byhttp://jaspervdj.be/lorem-markdownum/.ChangelogseeGithub release page.ToDosWhat still has to be implemented:support for multilingual content, seepelican translations(it in fact may work, but I have not tested it)ContributorsThanks to all contributers!dArignac(Owner)wamomite(Pull Request #8)wAmpIre(Pull Request #9)Bug Reporters:jakub-olczykVorpalBlade
Package: pelican-featured-image
Featured Image: A Plugin for PelicanThis Pelican plugin extracts an image from the summary or content of an article or page if not already specified in content metadata.InstallationThis plugin can be installed via:python -m pip install pelican-featured-imageAs long as you have not explicitly added aPLUGINSsetting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must addfeatured_imageto your existingPLUGINSlist. For more information, please see theHow to Use Pluginsdocumentation.UsageTo override the default behavior of selecting the first image in the article's summary or content, set the image property the article's metadata to the URL of the image to display, e.g:Title: My super title
Date: 2010-12-03 10:20
Category: Python
Tags: pelican, publishing
Slug: my-super-post
Author: Alexis Metaireau
Summary: Short version for index and feeds
Image: /images/my-super-image.png

Article content...PageTo include a representative image in a page add the following to the template:{% if page.featured_image %}<imgsrc="{{ page.featured_image }}">{% endif %}ArticleTo include a representative image in an article add the following to the template:{% if article.featured_image %}<imgsrc="{{ article.featured_image }}">{% 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.LicenseThis project is licensed under the AGPL-3.0 license.
Package: pelican-feed-content-footer
Feed Content Footer: A Plugin for PelicanPelican plugin that adds a footer to RSS/Atom feed items content.InstallationThis plugin can be installed via:python -m pip install pelican-feed-content-footerAs long as you have not explicitly added aPLUGINSsetting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must addfeed_content_footerto your existingPLUGINSlist. For more information, please see theHow to Use Pluginsdocumentation.UsageAdd the following to your settings file:FEED_CONTENT_FOOTERA string that will be appended to the content of every entry in your Atom feed and, ifRSS_FEED_SUMMARY_ONLYisFalse, to the description of every item in your RSS feed inside a HTML footer tag.LicenseThis project is licensed under the AGPL-3.0 license.
Package: pelican-feed-filter
Feed FilterFeed Filter is a Pelican plugin that filters elements from feeds.InstallationThis plugin can be installed via:python -m pip install pelican-feed-filterUsageThis plugin is configured through your Pelican configuration file, by setting the following variable:FEED_FILTER = {}Define feed paths and include/exclude filters to apply to matching feeds. Both feed paths and filters are matched usingUnix shell-stye wildcards.Filters are defined as:include.item attributeexclude.item_attributewhereitem_attributecan be anyfeed item attribute, ie.title,link,author_name,categories, ...You can also matchpubdateandupdateddateitem attributes as strings formatted with the following format:%a, %d %b %Y %H:%M:%S(e.g. 'Thu, 28 Jun 2001 14:17:15')Filter prioritiesIf an inclusion filter is defined, only feed elements that match the filter will be included in the feed.If an exclusion filter is defined, all feed elements except those which match the filter will be included in the feed.If both include and exclude filters are defined, all feed elements except those which match some exclusion filter but no inclusion filter, will be included in the feed.If multiple inclusion/exclusion filters are defined for the same feed path, a single match is enough to include the item in the feed.Usage examplesInclude only posts in some categories into the global feed:FEED_ATOM = 'feed/atom'
FEED_RSS = 'feed/rss'
FEED_FILTER = {
    'feed/*': {
        'include.categories': ['software-*', 'programming']
    }
}Exclude an author from a category feed:CATEGORY_FEED_ATOM = 'feed/{slug}.atom'
CATEGORY_FEED_RSS = 'feed/{slug}.rss'
FEED_FILTER = {
    'feed/a-category-slug.*': {
        'exclude.author_name': 'An Author name'
    }
}Exclude an author from all category feeds:CATEGORY_FEED_ATOM = 'feed/{slug}.atom'
CATEGORY_FEED_RSS = 'feed/{slug}.rss'
FEED_FILTER = {
    'feed/*.*': {
        'exclude.author_name': 'An Author name'
    }
}In the global feed, exclude all posts in a category, except if written by a given author:FEED_ATOM = 'feed/atom'
FEED_RSS = 'feed/rss'
FEED_FILTER = {
    'feed/*': {
        'include.author_name': 'An Author name',
        'exclude.category': 'software-development'
    }
}In the global feed, exclude all posts whose title starts with "Review":FEED_ATOM = 'feed/atom'
FEED_RSS = 'feed/rss'
FEED_FILTER = {
    'feed/*': {
        'exclude.title': 'Review*'
    }
}In the global feed, include all posts written by a given author OR in a certain category, except if the title starts with "Review":FEED_ATOM = 'feed/atom'
FEED_RSS = 'feed/rss'
FEED_FILTER = {
    'feed/*': {
        'include.author_name': 'An Author name',
        'include.category': 'software-development'
        'exclude.title': 'Review*'
    }
}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.