Saravanan666/pypi-org huggingface dataset:
Package: pelican-feed-stylesheet
pelican-feed-stylesheet: A Plugin for PelicanEnables use of xml stylesheets for human-readable feed generation.InstallationThis plugin can be installed via:python -m pip install pelican-feed-stylesheetUsageAdd the following to settings to enable:FEED_STYLESHEET="/YOUR_URL_HERE.xls"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 BSD-3-Clause license.
Package: pelican-figures
Figures: A Plugin for PelicanEncapsulate standalone images in a figure tag and add a figcaption tag.InstallationThis plugin can be installed via:python -m pip install pelican-figuresUsage<>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-flickrtag
Pelican Flickr Tag is a library to make it easy to display Flickr images in yourPelicanblogs.InstallationTo install the plugin, simply:$pipinstallpelican-flickrtagThen add a bit of code to your blog configuration:PLUGINS=[# ...'pelican_flickrtag',# ...]UsageIn your articles, just add lines to your posts that look like:[flickr:id=5128831453]This will tell the plugin to insert the image with id8152886277into your post. By default the resulting HTML will look like:<pclass="caption-container"><aclass="caption"href="http://www.flickr.com/photos/chrisstreeter/5128831453/"target="_blank"><imgsrc="http://farm5.static.flickr.com/4037/5128831453_792359af82_z.jpg"alt="Sand Dunes"title="Sand Dunes"class="img-polaroid"/></a><spanclass="caption-text muted">Sand Dunes</span></p>If you want a custom title, you can use:[flickr:id=5128831453,title=Sand dunes at Inyo, California]If you want to change what the output looks like, you can create your own Jinja template and stick it in your theme directory. Then override theFLICKR_TAG_TEMPLATE_NAMEsetting to point to your template. See below for more information.SettingsFLICKR_TAG_TEMPLATE_NAME- Specifies the name of the template to be used to render each replaced tag. This uses Pelican’s template lookup to find the name of the template. If the template is namedflickrtag.html, then this setting should be set toflickrtag. (Optional) The default template looks like:<pclass="caption-container"><aclass="caption"href="{{url}}"target="_blank"><imgsrc="{{raw_url}}"alt="{{title}}"title="{{title}}"class="img-polaroid"{%ifFLICKR_TAG_INCLUDE_DIMENSIONS%}width="{{width}}"height="{{height}}"{%endif%}/></a><spanclass="caption-text muted">{{title}}</span></p>FLICKR_TAG_CACHE_LOCATION- The cache location which stores the looked up photo information. This dramatically speeds up building of the site and permits you to do it offline as well. Defaults to/tmp/com.chrisstreeter.flickrtag-images.cache(Optional)FLICKR_TAG_INCLUDE_DIMENSIONS- Whether to include the dimensions on the image tag generated by the template. Default isFalse. (Optional)FLICKR_TAG_IMAGE_SIZE- The size alias used ifFLICKR_TAG_INCLUDE_DIMENSIONSis set toTrue. Default is ‘Medium 640’. See theFlickr getSizes documentationfor the valid values. (Optional)Flickr SettingsThe following two settings are required. In order to set them up, you will need to set up a Flickr API key. You can do this bycreating an app on Flickr. If the blog is a personal blog, then apply for a non-commercial key. Once you’ve got your key and secret, add them to yourPelican configuration.FLICKR_API_KEY- The API key for your app to access the Flickr API. (Required)FLICKR_API_SECRET- The API secret for your app to access the Flickr API. (Required)Flickr TokensA Flickr API token is only required if you want to access photos that are private to your account and cannot be gotten through the public API. I’ll assume you know what you’re doing and how to get a Flickr API token for this setting.FLICKR_API_TOKEN- The API token to access the Flickr API. (Optional)NotesUses portions of code fromflickrpy.LicenseUses theMITlicense.
Package: pelicanfly
IntroductionThis ispelicanfly, a plugin forPelicanthat lets you type things likei ♥:fa-coffee:in yourMarkdowndocuments and have it come
out as littleFont Awesomeicons in the browser.
It provides a minimal extension to Markdown and a plugin for Pelican.The Pelican plugin hacks in some static assets to make this work with
Pelican “out of the box”. If you just want the Markdown extension, it is
availableseparately.InstallationIt’s not hard, just install via pip:(env)$pipinstallpelicanflyThen add to your Pelican settings, underPLUGINSas follows:PLUGINS=[# ...'pelicanfly',# ...]If you have followed these steps correctly, next time you build your
Pelican blog, pelicanfly will do its magic and convert all the:fa-heart:style tags into proper nice little Font Awesome icons.
Job done!
Package: pelican-fontawesome
Pelican FontAwesome allows you to embed FontAwesome icons in your RST documents.InstallationTo install pelican-fontawesome, simply install it from PyPI:$pipinstallpelican-fontawesomeThen enabled it in your pelicanconf.pyPLUGINS=[# ...'pelican_fontawesome',# ...]Include the FontAwesome CSS in your base template.<linkhref="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css"rel="stylesheet">UsageIn your article or page, you simply need to add a line to embed you video.:fa:`fa-github`Which will result in:<spanclass="fa fa-github"></span>LicenseMITlicense.
Package: pelican-frontmark
Pelican FrontMarkA Pelican CommonMark/Front Matter reader.This reader marse Markdown files with YAML frontmatter headers and formatted using the CommonMark specifications.RequirementsPelican FrontMark works with Pelican 3.7+ and Python 3.3+Getting startedInstallpelican-frontmarkwith pip:pipinstallpelican-frontmarkAnd enable the plugin in youpelicanconf.py(or any configuration file you want to use):PLUGINS=['...','frontmark','...',]Files formatFrontmark will only recognize files using.mdextension.Here an article example:---
title: My article title
date: 2017-01-04 13:10
modified: 2017-01-04 13:13
tags:
  - tag 1
  - tag 2
slug: my-article-slug
lang: en
category: A category
authors: Me
summary: Some summary
status: draft

custom:
  title: A custom metadata
  details: You can add any structured and typed YAML metadata

---

My article contentAdvanced configurationSyntax highlightingBy default,FrontMarkoutputs code blocks in a standard html5 way,
ie. apre>codeblock with a language class.
This allow to use any html5 syntax highlight JavaScript lib.You can force Pygments usage to output html4 pre rendered syntax highlight
by settingFRONTMARK_PYGMENTStoTruefor default parameters
or manually setting it to a dict of Pygments HtmlRenderer parameters.FRONTMARK_PYGMENTS={'linenos':'inline',}Settings`FRONTMARK_PARSE_LITERAL`:Trueby default. Set it toFalseif you don’t want multiline string literals (|)
to be parsed as markdown.`FRONTMARK_PYGMENTS`: Not defined by default and output standard html5 code blocks.
Can be set toTrueto force Pygments usage with default parameters or adictofPygments parametersRegistering custom YAML typesYou can register custom YAML types using thefrontmark_yaml_registersignal:fromfrontmark.signalsimportfrontmark_yaml_registerdefupper_constructor(loader,noder):returnloader.construct_scalar(node).upper()defregister_upper(reader):return'!upper',upper_constructordefregister():frontmark_yaml_register.connected(register_upper):TestingTo test the plugin against all supported Python versions, run tox:toxTo test only within your current Python version with pytest:pipinstall-e.[test]# Install with test dependenciespytest# Launch pytest test suiteor let setuptools do the job:pythonsetup.pytestChangelog1.2.1 (2019-12-09)Support CommonMark 0.9.11.2.0 (2018-09-08)Upgrade to CommonMark 0.8+Drop support for Python version prior to 3.51.1.0 (2017-01-22)AddedFRONTMARK_PYGMENTSoptionnal setting for Pygments renderingFix links handling (ie.{filename}…)1.0.1 (2017-01-08)Test and fix plugin registerationMake version and description available at module level1.0.0 (2017-01-08)Initial release
Package: pelican-ga-pageview
pelican-ga-pageviewGoogle analytics pageview plugin to work with nice blog themePage View using Google AnalyticsIf you track your site's page view using Google Analytics, this plugin can pull
the page view information from your Google Analytics profile and add apage_viewattribute to each article and page in your Pelican site. See a
live example here.http://jwkennington.comRequirements and SetupFirst, follow theinstructions here <https://developers.google.com/analytics/devguides/reporting/core/v3/quickstart/service-py>_
to set up Google API service account.Then in Google Analytics, add the email address you created above as an user so
that we can access the Google Anaytics API.At this point, you should have:Google API service email:<prioject_id>-<unique_id>@developer.gserviceaccount.comGoogle private key file:client_private.p12. Save this file somewhere
secure. If you put this file in a Git repository, don't forget to add it to.gitignore.Finally, install the Google API Python library:pipinstall--upgradegoogle-api-python-clientSettingsYou need to provide the following information in your Pelican configuration file
for this plugin to communicate with the Google Analytics API.GOOGLE_SERVICE_ACCOUNT: the service email.GOOGLE_KEY_FILE: path to the private key file, E.g../client_private.p12.GA_START_DATE: start date to count page view. E.g.,2005-01-01.GA_END_DATE: end date to count page view. E.g.,today.GA_METRIC: counting metrics, default isga:pageviews. See other optionshere <https://developers.google.com/analytics/devguides/reporting/core/dimsmets>_.
Right now we only support query with ONE metric.POPULAR_POST_START: start date to count popular page views. E.g.,A month ago.With this plugin installed, eacharticleandpageobject has two extra
attributes:pageview: total number of page views betweenGA_START_DATEandGA_END_DATE.popular_pageview: total number of page view betweenPOPULAR_POST_STARTandGA_END_DATE.And there is one global context namedtotal_page_view,
which is the total page view of the entire site.NoteIf you encounter this error while building:NotImplementedError:PKCS12formatisnotsupportedbythePyCryptolibrary.Try convert thep12file topemfile:opensslpkcs12-inclient_private.p12-nodes-nocerts>client_private.pemThe password should benotasecret.Then setGOOGLE_KEY_FILEto be thepemfile just generated.ResourcesGoogle Analytics Core Reporting API <https://developers.google.com/analytics/devguides/reporting/core/v3/reference>_Google Analytics Query Explorer <https://ga-dev-tools.appspot.com/query-explorer/>_AttributionThis plugin is based on thega_pageview plugin
Package: pelican-gesetze
Pelican plugin forpy-gesetzepelican-gesetzelinks german legal norms, dependency-free & GDPR-friendly.InstallationIt's available fromPyPiusing a package manager of your choice:# Using 'pip'
pip install pelican-gesetze

# Using 'poetry'
poetry add pelican-gesetzeGetting startedUsingpelican-gesetzeis straightforward: After installing it, the jinja filtergesetzifyis available:<pclass="content">{{ page.content | gesetzify }}</p>ConfigurationThe following settings need to be prepended byGESETZE_to work, eg for enabling fulltitleattributes, defineGESETZE_TITLE_ATTRIBUTE = 'full'in your settings(most likelypelicanconf.py).SettingTypeDefaultDescriptionDRIVER_ORDER`liststr`['gesetze', 'dejure', 'buzer', 'lexparency']TITLE_ATTRIBUTE`strFalse`FalseCUSTOM_ATTRIBUTESdict{"target": "_blank"}Defines HTML attribute defaultsFor more information, seehere.RoadmapUpdateREADME.mdAdd tests
Package: pelican-gist
Pelican Gist Tag is a library to make it easy to GitHub Gists in yourPelicanblogs.InstallationTo install pelican-gist, simply:$pipinstallpelican-gistThen add a bit of code to your blog configuration:PLUGINS=[# ...'pelican_gist',# ...]UsageIn your articles, just add lines to your posts that look like:[gist:id=3254906,file=brew-update-notifier.sh]This will tell the plugin to insert gist id3254906and choose the filebrew-update-notifier.shinto your post. The resulting HTML will look like:<divclass="gist"><scriptsrc='https://gist.github.com/3254906.js?file=brew-update-notifier.sh'></script><noscript><pre><code>#!/bin/bash ...</code></pre></noscript></div>If your gist has only a single file, you can also specify the gist like so:[gist:id=3254906]Notice it is using the id only. The resulting HTML will look like:<divclass="gist"><scriptsrc='https://gist.github.com/3254906.js'></script><noscript><pre><code>#!/bin/bash ...</code></pre></noscript></div>If a file type is specified, uses pygment to highlight the noscript version of the code:[gist:id=3254906,file=brew-update-notifier.sh,filetype=bash]There is also support for private gists where they have the gist id that looks likee34db4c532a6cfa1f711.SettingsGIST_CACHE_ENABLED- Specifies whether to cache the gist on disk or not. Default isTrue. (Optional)GIST_PYGMENTS_STYLE- Style used by pygments for syntax highlighting. Possible values are the strings frompygments.styles.get_all_styles(). Default is'default'. (Optional)GIST_PYGMENTS_LINENUM- Defines if pygments should add line numbers to the rendered HTML. Default isFalse. (Optional)TestingInstall the necessary requirements withpip install -r requirements.txt. Once those are installed, you can run the tests with:py.test. So the whole workflow looks like:$pipinstall-rrequrements.txtSuccessfullyinstalledpytestrequestsmockpyCleaningup...$py.test========================testsessionstarts=========================platformdarwin--Python2.7.6--pytest-2.5.1collected5itemspelican_gist/test_plugin.py.....======================5passedin0.11seconds======================AuthorsSeecontributorson GitHub.Changelog0.3.4 - Fix regex to support filetype (credit [@andrlik](https://github.com/andrlik))0.3.3 - Support gists with UTF-8 characters0.3.2 - Added universal wheel support0.3.1 - Fixed an issue with Python 3 and fetching gist content0.3.0 - Added Python 3 supportLicenseUses theMITlicense.
Package: pelican-git
Pelican Git is a library that makes it easy to embed GitHub files in yourPelicanblogs using simple syntax.InstallationTo installpelican-git, simply usepip:$pipinstallpelican-gitThen add a bit of code to yourpelicanconfiguration file:PLUGINS=[# ...'pelican_git',# ...]UsageIn your articles, add lines to your posts that look like:[git:repo=yourname/yourrepo,file=somefile,branch=master,hash=xxxxxxx]branchandhashare optional. If you don’t specifybranch, it will bemaster. If you specifyhashit will overwrite thebranchsetting.The generated code will embedcssandhtmlcontent directly into adivand replace the original tag. This is faster and cleaner than usingjavascriptto rewrite the page content like whatgist_itdoes.SettingsGIT_CACHE_ENABLED- Specifies whether to cache the git files on disk or not. Default isFalse. (Optional)Testing$makeinstall$maketestAuthorsHa.MinhInspired bypelican_gistChangelog0.1.13FixedFixed error when fetching github HTMLChangedSupport Python 3.60.1.8FixedFix link to original repo0.1.0ddedInitial versionLicenseUses theMITlicense.
Package: pelican-github-activity
pelican-github-activityGithub activity plugin made to work with nice-blog themeGitHub activityThis plugin makes use of thefeedparser_ library that you'll need to
install.Set theGITHUB_ACTIVITY_FEEDparameter to your GitHub activity feed.
For example, to track Pelican project activity, the setting would be::GITHUB_ACTIVITY_FEED = 'https://github.com/getpelican.atom'If you want to limit the amount of entries to a certain maximum set theGITHUB_ACTIVITY_MAX_ENTRIESparameter.GITHUB_ACTIVITY_MAX_ENTRIES = 10On the template side, you just have to iterate over thegithub_activityvariable, as in this example::{% if GITHUB_ACTIVITY_FEED %}
    <div class="social">
            <h2>Github Activity</h2>
            <ul>

            {% for entry in github_activity %}
                <li><b>{{ entry[0] }}</b><br /> {{ entry[1] }}</li>
            {% endfor %}
            </ul>
    </div><!-- /.github_activity -->
 {% endif %}github_activityis a list of lists. The first element is the title,
and the second element is the raw HTML from GitHub.feedparserAcknowledgementsThis package is based on thegithub_activitypackage byMario Langand
updated to work with the nice-blog theme.
Package: pelican-githubprojects
Embed a list of your public GitHub projects in your pages.InstallationTo install pelican-githubprojects, simply install it from PyPI:$pipinstallpelican-githubprojectsConfigurationEnable the plugin in your pelicanconf.pyPLUGINS=[# ...'pelican_githubprojects',# ...]Add a setting with your GitHub username.GITHUB_USER='kura'Available dataname:The name of your project.language:The language your project is written in, information on how GitHub detects
languages isavailable here.
It is GitHub that detects the language, not this plugin. So please, no
issues about that.description:The description of your project (as set on GitHub.)homepage:The homepage of your project (as set on GitHub.)github_url:The web page URL of your project on GitHub (not the GIT or API URL.)UsageIn your templates you will be able to iterate over thegithub_projectsvariable, as below.{% if GITHUB_USER %}<h1>Projects</h1>{% for project in github_projects %}<h2>{{ project.name }}<sup>({{ project.language }})</sup></h2><p>{{ project.description }}</p><p><ahref="{{ project.homepage }}">Homepage</a><ahref="{{ project.github_url }}">GitHub</a></p>{% endfor %}
{% endif %}LicenseMITlicense.
Package: pelican-github-projects
Embed a list of your public GitHub projects in your pages.InstallationTo install pelican-github-projects, simply install it from PyPI:$pipinstallpelican-github-projectsConfigurationEnable the plugin in your pelicanconf.pyPLUGINS=[# ...'pelican-github-projects',# ...]Add a setting with your GitHub username.GITHUB_USER='kyah'Available dataname:The name of your project.language:The language your project is written in, information on how GitHub detects
languages isavailable here.
It is GitHub that detects the language, not this plugin. So please, no
issues about that.description:The description of your project (as set on GitHub.)homepage:The homepage of your project (as set on GitHub.)github_url:The web page URL of your project on GitHub (not the GIT or API URL.)UsageIn your templates you will be able to iterate over thegithub_projectsvariable, as below.{% if GITHUB_USER %}
    {% for project in github_projects %}<h2>{{ project.name }} {% if project.language %}<sup>({{ project.language }})</sup>{% endif %}</h2><p>{{ project.description }}</p><p>{% if project.homepage %}<ahref="{{ project.homepage }}">Homepage</a>{% endif %}<ahref="{{ project.github_url }}">GitHub</a></p>{% endfor %}
{% endif %}LicenseGPLv2license.
Package: pelican-granular-signals
Ensure that your Pelican plugin is called at the right time, every time.LovePelicanbut hate that your finalization plugin isn’t always called in the right order?
Don’t let your plugin get lost in the shuffle of thefinalizedsignal!pelican-granular-signalsadds new finalization signals
that guarantee your plugin is called at the right time, every time.New Pelican signalsWhenpelican-granular-signalsis installed,
the following signals will be called immediately after thefinalizedsignal:sitemapoptimizeminifycompressdeployEach signal will be sent with the same argument that is sent to thefinalizedsignal.Connecting to granular signalsYour plugin must register withblinkerdirectly.
Here’s a complete example:importblinkerimportpelican.plugins.granular_signalsdefregister():# This line is highly recommended so users# don't have to update their configurations.pelican.plugins.granular_signals.register()# Connect your awesome plugin to a granular signal.blinker.signal("deploy").connect(deploy_site)# -----------------------------------------------------# Put your awesome plugin code here.importsubprocessdefdeploy_site(instance):subprocess.run(instance.settings["DEPLOY_COMMAND"])Helping users outTo make life easier for users, consider taking these two steps:Listpelican-granular-signalsas a dependency so it will be automatically installed with your plugin.When Pelican calls your plugin’sregister()function, callpelican.plugins.granular_signals.register().Pelican 4.5 introduced a new, automatic plugin loading feature
andpelican-granular-signalsis designed to work with this feature!
Unfortunately, if a user specifies which plugins to load in their configuration file
then automatic plugin loading will be disabled.
It is therefore recommended that you callpelican.plugins.granular_signals.register()in your plugin’sregister()function.pelican.plugins.granular_signals.register()can be called multiple times without creating any problems.
Package: pelican_gravatar_plus
# Pelican Plugin – Gravatar PlusJust like the [regular Pelican Gravatar Plugin](https://pelican.readthedocs.org/en/latest/plugins.html#gravatar) but creates a Gravatar object stored in theauthor_gravatarcontext variable that gives you access to a few more things.By the way: access the variable in yourarticle.htmltemplate using{{ article.author_gravatar }}.
Package: pelican_hot
Pelican Hot Plugin is a plugin for pelican to show hot posts on your blog.
These hot posts will be selected based on the social media score.
Now, you can choose it from Twitter or Facebook (also both.)InstallationThis plugin is not registered on PyPI. You should clone this repository and install through pip:git clone git@github.com:wutali/pelican_hot.git
cd pelican_hot
pip install -e .ConfigurationPut this code on your pelicanconf.py and customize it:HOT_POSTS_DUMMY = False # Insert dummy articles as a hot posts for the development environment.
HOT_POSTS_MAX = 7 # Show hot posts limited by this.
HOT_POSTS_INCLUDE_FACEBOOK = True # Weight which post is hot based on Facebook shares.
HOT_POSTS_INCLUDE_TWITTER = True # Weight which post is hot based on Twitter tweets.
HOT_POSTS_SHUFFLE = True # Shuffle the hot posts before showing it.LicensePelican hot is released under the MIT License.http://www.opensource.org/licenses/mit-license
Package: pelican-htmlmin
pelican-htmlminAPelicanplugin usinghtmlminto remove comments and extra
whitespace from your website.Turning this:<head><title>Hello, World!</title></head><body><p>How<em>you</em>doing?</p></body>Into this:<head><title>Hello, World!</title><body><p>How<em>you</em>doing?</p></body>Installingpelican-htmlmin, is available onpipand takes advantage of
Pelican’s namespace system to automatically register installed plugins.Just install withpipand you’re ready to go:$ pip install pelican-htmlminFor a more detailed plugin installation guide, please refer to thePelican Plugin Documentation.OptionsBeing a very small wrapper aroundhtmlmin, there are only a few options
that you may need.HTMLMIN_ENABLEDBy Default, if Pelican is inDEBUGmode,pelican-htmlminwill
not minify any files, to help with debugging. To override this, setHTMLMIN_ENABLED = Trueto minify files regardless of theDEBUGflag.HTMLMIN_ENABLED=logger.getEffectiveLevel()>logging.DEBUGHTMLMIN_MATCHOut of the box,pelican-htmlminlooks for files ending with.htmlor.htmto minify. You can use theHTMLMIN_MATCHto change the regular expression that matches the files you wish to minify.HTMLMIN_MATCH=r'.html?$'HTMLMIN_OPTIONSIf you wish to pass arguments directly tohtmlmin, use theHTMLMIN_OPTIONSto pass keyword arguments.HTMLMIN_OPTIONS={'remove_comments':True,'remove_all_empty_space':True,'remove_optional_attribute_quotes':False}For more information on the arguments you can givehtmlmin, see theirdocumentation hereContributingPlease feel free to help.Buying me Beer, emailing issues, orpatches via
email, are all warmly welcomed,
especially beer.