Saravanan666/pypi-org huggingface dataset:
Package: pelican-sitemap
SitemapThisPelicanplugin generates a site map in plain-text or XML format. You can use theSITEMAPvariable in your settings file to configure the behavior of the plugin.InstallationThis plugin can be installed via:python -m pip install pelican-sitemapUsageTheSITEMAPsetting must be a Python dictionary and can contain these keys:format, which sets the output format of the plugin (xmlortxt)priorities, which is a dictionary with three keys:articles, the priority for the URLs of the articles and their translationspages, the priority for the URLs of the static pagesindexes, the priority for the URLs of the index pages, such as tags, author pages, categories indexes, archives, etc.All the values of this dictionary must be decimal numbers between0and1.changefreqs, which is a dictionary with three items:articles, the update frequency of the articlespages, the update frequency of the pagesindexes, the update frequency of the index pagesValid frequency values arealways,hourly,daily,weekly,monthly,yearlyandnever.exclude, which is a list of regular expressions that will be used to exclude matched URLs from the sitemap ifanyof them match. For example:SITEMAP={"exclude":["^/noindex/",# starts with "/noindex/""/tag/",# contains "/tag/""\.json$",# ends with ".json"]}If a key is missing or a value is incorrect, it will be replaced with the default value.You can also exclude an individual URL by adding metadata to it, settingprivatetoTrue.The sitemap is saved in:<output_path>/sitemap.<format>Note:prioritiesandchangefreqsare information for search engines and are only used in the XML site maps. For more information, see:https://www.sitemaps.org/protocol.html#xmlTagDefinitionsExampleHere is an example configuration (it is also the default settings):SITEMAP={"format":"xml","priorities":{"articles":0.5,"indexes":0.5,"pages":0.5},"changefreqs":{"articles":"monthly","indexes":"daily","pages":"monthly"}}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 theAGPL-3.0license.
Package: pelican_slug
Pelican is good project but slugify function is a little bit unuseful and not customizable.
This problem will appear if you are a developer using multi-byte language.
So we wanna exchange multi-byte words to alphabetical words caused by multi-byte url problem.URL encoded word is not beautiful, Japanese word Otaku will change like this “%83I%83%5E%83N”.
If we can use an URL containing only alphabets and other marks not multi-byte, we wanna do that.Pelican try to automatically exchange it. But Japanese and some multi-byte languages are very complex
that because they are having some pronounciations. This try will absolutely be failure and they make
funny words we could not read it.This plugin will help these situation. You can define some slugs for your categories like this:CATEGORY_SLUGS = (
    (u'オタク', u'otaku'),
    (u'寿司', u'sushi'),
)Another feature is that to define your slugify function like this:def SLUG_FUNC(value, substitutions=()):
    value = value.replace(u'禅', 'zen')
    return valueThese settings are on your pelicanconf.py then just work.InstallationThis plugin is not registered on PyPI. You should clone this repository and install through pip:git clone git@github.com:wutali/pelican_slug.git
cd pelican_slug
pip install -e .ConfigurationPut this code on your pelicanconf.py and customize it:PLUGINS = ['pelican_slug']

def SLUG_FUNC(value, substitutions=()):
    # Do something you want.
    return value

CATEGORY_SLUGS = (
    (u'オタク', u'otaku'),
    (u'寿司', u'sushi'),
)LicensePelican Slug is released under the MIT License.http://www.opensource.org/licenses/mit-license
Package: pelican-social
Social plugin for PelicanSocial directives forPelicanstatic blog generator.Easy linking to social networks content through simple inline directives.Compatibilitypelican-social is compatible withPelican3.3+ and Python 2.7.InstallationInstall the plugin viapip:~$pipinstallpelican-socialUsageTo load the plugin, you have to add it in your settings file.PLUGINS=('social',)Once loaded you have access to social rst directives.Each directive can be called in two forms::network:`target`:network:`Displayed text <target>`As much as possible, the directive give a secure (https) link.TwitterYou can use both:twitter:and:tw:directives to link to aTwitterprofile,
they are equivalent.
Using an@in username will only change the displayed username
if a custom display is not specified.Exemple::twitter:`username`:twitter:`@username`:twitter:`User <username>`:twitter:`User <@username>`will result in:<ahref="https://twitter.com/username">username</a><ahref="https://twitter.com/username">&#64;username</a><ahref="https://twitter.com/username">User</a><ahref="https://twitter.com/username">User</a>Google+Google+is tricky with usernames.
If you are famous and lucky you can have a custom username in+MyUserform.
If not you will have a 21 digits identifier.Exemple::gplus:`username`:gplus:`User <username>`will result in:<ahref="https://plus.google.com/username">username</a><ahref="https://plus.google.com/username">User</a>GithubYou can use both:github:and:gh:directive to link
togithubprofiles, repositories and issues/pull-requests
(github will autmatically redirect you to the pull-request if one is associated with the issue).The following form are accepted:TargetExpected target formprofileusernamerepositoryusername/repositoryissue/pull-requestusername/repository#issueExemple::github:`username`:github:`User <username>`:github:`username/repository`:github:`Repository <username/repository>`:github:`username/repository#2`:github:`Issue #2 <username/repository#2>`will result in:<ahref="https://github.com/username">username</a><ahref="https://github.com/username">User</a><ahref="https://github.com/username/repository">repository</a><ahref="https://github.com/username/repository">Repository</a><ahref="https://github.com/username/repository/issues/2">#2</a><ahref="https://github.com/username/repository/issues/2">Issue #2</a>FacebookYou can use both:facebook:and:fb:directives to link to aFacebookprofile,
they are equivalent.Exemple::facebook:`User <username>`:facebook:`username`will result in:<ahref="https://facebook.com/username">User</a><ahref="https://facebook.com/username">username</a>Changelog0.2.0 (2017-02-02)Support for Pelican 3.7+ and Python 3.3+Drop support for Python 3.20.1.1 (2013-07-02)Handle dot and dashes in Github usernames and repository names0.1 (2013-06-20)Initial implementation allowing to link to:Facebook profilesTwitter profilesGoogle+ profilesGithub profiles, repositories and issues
Package: pelican-stat
pelican_statcli tool for generating pelican article statisticsGetting StartedPrerequisitespipxUsageAs I pin pelican to 4.5.4 for API consistency, I suggest using pipx (or any other virtual environment mechanism) to install this tool.pipxinstallpelican_statAfter installation, you can see the detail by add--helpflag.e.g.,pelican-stat--helporpelican-statplot--helpContributingSeeContributingAuthorsWei Leeweilee.rx@gmail.comCreated fromLee-W/cookiecutter-python-templateversion 0.6.1
Package: pelican-syntax-highlighting
Syntax Highlighting: A Plugin for PelicanHighlight syntax using Prism.js, Highlight.js or PygmentsInstallationThis plugin can be installed via:python -m pip install pelican-syntax-highlightingUsage<>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-table-wrapper
Pelican plugin for wrapping table into classed div.table_wrapper. It allows
you to better style tables. E.g. make them scrollable on small displays.InstallationThis plugin can be installed via:python -m pip install pelican-table-wrapperUsageTo use this plugin you have to add it to PLUGINS variable in pelicanconf.py:PLUGINS=['table_wrapper',...]If you don't want add.table_wrapperto your CSS, plugin can generate self-styled
elements. Just specify style that you want in pelicanconf.py:TABLE_WRAPPER={'style':'overflow: auto;'}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 MIT license.
Package: pelican-tag-cloud
Tag Cloud: A Plugin for PelicanThis Pelican plugin generates a tag cloud from post tags.InstallationThis plugin can be installed via:python -m pip install pelican-tag-cloudFor more detailed plugin installation instructions, please refer to thePelican Plugin Documentation.In order to use to use this plugin, you must edit your theme’s base template and style-sheet. You should changebase.htmlto apply formats (and sizes) defined instyle.css, as specified inSettingsbelow.SettingsSettings and their default valuesWhat does it do?TAG_CLOUD_STEPS = 4Count of different font sizes in the tag cloudTAG_CLOUD_MAX_ITEMS = 100Maximum number of tags in the cloudTAG_CLOUD_SORTING = "random"Tag cloud ordering scheme. Valid values: random, alphabetically, alphabetically-rev, size, and size-revTAG_CLOUD_BADGE = TrueOptional setting: turn onbadges, displaying the number of articles using each tagUsageThe default theme does not include a tag cloud, but it is fairly easy to add one:<ul class="tagcloud">
    {% for tag in tag_cloud %}
        <li class="tag-{{ tag.1 }}">
            <a href="{{ SITEURL }}/{{ tag.0.url }}">
            {{ tag.0 }}
                {% if TAG_CLOUD_BADGE %}
                    <span class="badge">{{ tag.2 }}</span>
                {% endif %}
            </a>
        </li>
    {% endfor %}
</ul>You should then also define CSS styles with appropriate classes (tag-1 to tag-N, where N matchesTAG_CLOUD_STEPS), tag-1 being the most frequent, and define aul.tagcloudclass with appropriate list-style to create the cloud. You should copy+paste thisbadgeCSS ruleul.tagcloud .list-group-item <span>.badgeif you are using theTAG_CLOUD_BADGEsetting. (This rule, potentially long, is suggested to avoid conflicts with CSS frameworks such as Twitter Bootstrap.)For example:ul.tagcloud{list-style:none;padding:0;}ul.tagcloudli{display:inline-block;}li.tag-1{font-size:150%;}li.tag-2{font-size:120%;}/* ... add li.tag-3 etc, as much as needed */ul.tagcloud.list-group-itemspan.badge{background-color:grey;color:white;}By default, the tags in the cloud are sorted randomly, but if you prefer to have them sorted alphabetically, usealphabetically(ascending) andalphabetically-rev(descending). Also, it is possible to sort the tags by frequency (number of articles with this specific tag) using the valuessize(ascending) andsize-rev(descending).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-tailwindcss
TailwindCSS Plugin for Pelican 🌬This plugin helps you useTailwindCSSin your Pelican website.AuthorGitHubTwitterLuca Fedrizzihttps://github.com/lcfdhttps://twitter.com/lc_fdWhy Use This Plugin?Because you want useTailwindCSSin seconds.
Not hours.RequirementsIn order to run this plugin, you need to install NodeJS. (I'm looking to replace this dependency by using a Python package. – Luca)InstallationThis plugin can be installed via:python -m pip install pelican-tailwindcssorpoetry add pelican-tailwindcssBasic UsageCreate atailwind.config.jsfile in your Pelican project root folder containing:/** @type {import('tailwindcss').Config} */module.exports={content:["./themes/**/*.html","./themes/**/*.js"],theme:{extend:{},},plugins:[],};Thecontentproperty values are just suggestions. Feel free to modify them according to your needs.Create ainput.cssfile in your Pelican project root folder containing:@tailwindbase;@tailwindcomponents;@tailwindutilities;Add the build file (output.css) in yourbase.html.<linkrel="stylesheet"href="/output.css"/>Done! You should be ready to useTailwindCSSin your website template.Advanced UsageIn your settings you can configure the plugin's behavior using theTAILWINDsetting.An example of a completeTAILWINDsetting:TAILWIND={"version":"3.0.0","plugins":["@tailwindcss/typography","@tailwindcss/forms","@tailwindcss/line-clamp","@tailwindcss/aspect-ratio",],}Tailwind plugins installAs you can see from the example above it is possible to add thepluginsproperty to the configuration.
Just add the name of a Tailwind plugin in this property and the plugin will be installed.Useful informationsPluginsYourtailwind.config.jsfile will only be copied when Pelican starts. This means that any changes after starting Pelican will not be considered. For example if you want to install a new plugin for Tailwind you will have to restart Pelican.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-theme-config
Theme Configuration: A Plugin for PelicanThis package provides a plugin for the Pelican static website generator and
adds support for themes to adjust Pelican's configuration using thethemeconf.pyfile located in the root directory of the theme.InstallationThis plugin can be installed via:python -m pip install pelican-theme-configUsageAddtheme_configto the list of plugins in thepelicanconf.pyfile, e.g.PLUGINS = [ "theme_config" ]From that point on, Pelican will try to load thethemeconf.pyfrom theme's
directory.OverviewThis plugin allows theme authors to create more self-contained themes since
everything that a theme requires can be configured within the theme itself:themes can be shipped with their own pluginsthemes can provide their static content (e.g. a theme that implements
Google's PWA can providemanifest.jsonthat should be put into the
root of the website)basically, authors could do almost anything :) since with this plugin
theme gets controlThe code is hooked up early in Pelican's start-up sequence leveraging the
"initialized" Pelican event, so almost every configuration option can be
safely redefined and would take effect.However, since the plugin hooks up after the sanity checks on the provided
configuration were done by Pelican this gives some opportunities and risks.
Basically, theme authors should be careful to adhere to Pelican's conventions
on the configuration directives, otherwise they may confuse their users.This plugin protects the following configuration options from being modified
by the theme:BINDCACHE_PATHPATHPELICAN_CLASSOUTPUT_PATHSITEURLTHEMETHEME_CONFIGTHEME_CONFIG_PROTECTEDPORTThis list can be configured by the end user inpelicanconf.pyif they want
to restrict it even further or make it more relaxed.  The goal is to give the
user the ability to define the expected behaviour for their configuration.The plugin introduces the following configuration options one can specify in
the primary Pelican configuration file:# The name of the file to lookup in theme's directory
THEME_CONFIG = "themeconf.py"

# The list of configuration options to be protected from modification
THEME_CONFIG_PROTECTED = ["PATH","OUTPUT_PATH"]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.CreditsAuthored byDmitry Khlebnikov.
Package: pelican-theme-smallweb
SmallWeb theme for Pelican static site generatorThis is a simple yet modern-looking theme for Pelican blogs. It uses no
JavaScript, and all HTML/CSS had been crafted by hand - rememberwebmasters?Demo:https://sio.github.io/pelican-smallweb/default/Theme name is inspired by the idea ofsmall web- a simpler old-style web of
personal pages that didn't actually disappear but has become a lot less
visible as Internet had grown older and larger.
Authors would like to thankMarginalia Searchfor keeping the spirit alive!Installation and usageThis theme is installable viaPyPI:$ pip install pelican-theme-smallwebLatest development version is also installable:$ pip install git+https://github.com/sio/pelican-smallweb/Import it in yourpelicanconf.py:frompelican.themesimportsmallwebTHEME=smallweb.path()Privacy concernsThis theme usesGoogle Fontsby default. If you do not want third-parties to
track your visitors, setALLOW_GOOGLE_FONTS = Falsein your pelicanconf.py
and (optionally) provide self-hosted version of fonts viaCSS_OVERRIDElist.No other third-party resources are referenced.No personally identifiable information is collected.
Package: pelican_thumbnail
Pelican Thumbnail Plugin is a plugin for pelican to select thumbnail from your post.Now, its developing state…InstallationThis plugin is not registered on PyPI. You should clone this repository and install through pip:git clone git@github.com:wutali/pelican_thumbnail.git
cd pelican_thumbnail
pip install -e .UsageIf you insert thumbnail for YouTube, add youtube meta tag like this:It is awesome!
==============

:date: 2014-01-01 00:00
:slug: awesome-youtube
:author: Me
:youtube: teAqRZX4hbYYou can do same thing to Niconico Movie (its japanese movie service.):It is great!
==============

:date: 2014-01-01 00:00
:slug: great-niconico
:author: Me
:niconico: sm19220627But Niconico movies original thumbnail is a little small…Use the thumbnail attribute of article object when you use thumbnail on your theme:<img src="{{ article.thumbnail }}" />LicensePelican Thumbnail is released under the MIT License.http://www.opensource.org/licenses/mit-license
Package: pelican-thumbnailer
Thumbnailer: A Plugin for PelicanThumbnailer is a Pelican plugin that creates thumbnails for all of the images found under a specific directory, in various thumbnail sizes.InstallationThis plugin can be installed via:python -m pip install pelican-thumbnailerPillowwill be automatically installed in order to resize the images, and the thumbnail will only be re-built if it doesn't already exist (to save processing time). Depending on your local environment and your image types, you may need to also installexternal librariesto add support for certain image file formats.As 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 addthumbnailerto your existingPLUGINSlist. For more information, please see theHow to Use Pluginsdocumentation.ConfigurationIMAGE_PATHis the path to the image directory. It should reside inside your content directory, and defaults topictures.THUMBNAIL_DIRis the path to the output sub-directory where the thumbnails are generated.THUMBNAIL_SIZESis a dictionary mapping size name to size specifications.
The generated filename will beoriginalname_thumbnailname.extunlessTHUMBNAIL_KEEP_NAMEis set.THUMBNAIL_KEEP_NAMEis a Boolean that, if set, puts the file with the original name in athumbnailnamefolder, named like the key inTHUMBNAIL_SIZES.THUMBNAIL_KEEP_TREEis a Boolean that, if set, saves the image directory tree.THUMBNAIL_INCLUDE_REGEXis an optional string that is used as regular expression to restrict thumbnailing to matching files. By default all files not starting with a dot are respected.Sizes can be specified using any of the following formats:wxhwill resize to exactlywxhcropping as necessary to get that sizewx?will resize so that the width is the specified size, and the height will scale to retain aspect ratio?xhsame aswx?but will height being a set sizesis a shorthand forwxhwherew=hContributingContributions 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-timegraphics-plugin
Time.Graphics plugin for Pelican: A Plugin for PelicanEasily embed Time.Graphics timelines in your Pelican articlesInstallationThis plugin can be installed via:pip install pelican-timegraphics-pluginNext add it to thePLUGINSsection ofpelicanconf.py.PLUGINS=['...','pelican.plugins.timegraphics''...',]UsageIn your articles, just add lines to your posts that look like:[timegraphics:id=123456,width=100%,height=400,allowfullscreen=1,frameborder=0]The resulting html will look like<iframesrc="https://time.graphics/embed?v=1&id=123456"width="100%"height="400"frameborder="0"allowfullscreen></iframe><astyle="font-size: 12px; text-decoration: none;"title="Powered by Time.Graphics"href="https://time.graphics">Powered by Time.Graphics</a></div>SettingsTIMEGRAPHICS_DEFAULT_WIDTHThe default with of a timeline. Default is'100%'Can be overruled on each timeline with thewidthparameterTIMEGRAPHICS_DEFAULT_HEIGHTThe default height of a timeline. Default is'400'Can be overruled on each timeline with theheightparameterTIMEGRAPHICS_ALLOW_FULLSCREENSets the default on whether users of your site can view timelines in fullscreen.Allowed values are'0'and'1'Default is'1'Can be overruled on each timeline with theallowfullscreenparameterTIMEGRAPHICS_SHOW_FRAMEBORDERWhether to show a border around each timelineAllowed values are'0'and'1'Default is'0'Can be overruled on each timeline with theframeborderparameterTIMEGRAPHICS_SHOW_POWERED_BYWhether to show "Powered by Time.Graphics" under the timelineAllowed values areTrueandFalseDefault isTrueContributingContributions 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.