pelican

Static site generator that supports Markdown and reST syntax. Powered by Python.

https://github.com/getpelican/pelican

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
3 of 473 committers (0.6%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.3%) to scientific vocabulary

Keywords

pelican python static-site-generator

Keywords from Contributors

closember templates pallets apps views wsgi werkzeug jinja forhumans humans

Last synced: 6 months ago · JSON representation

Repository

Static site generator that supports Markdown and reST syntax. Powered by Python.

Basic Info

Host: GitHub
Owner: getpelican
License: agpl-3.0
Language: Python
Default Branch: main
Homepage: https://getpelican.com
Size: 7.24 MB

Statistics

Stars: 13,010
Watchers: 333
Forks: 1,817
Open Issues: 81
Releases: 25

Topics

pelican python static-site-generator

Created over 15 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing Funding License Codeowners

README.rst

Pelican |build-status| |pypi-version| |downloads| |repology|
============================================================

Pelican is a static site generator, written in Python_, that allows you to create
web sites by composing text files in formats such as Markdown, reStructuredText, and HTML.

With Pelican, you can create web sites without worrying about databases or server-side programming.
Pelican generates static sites that can be served via any web server or hosting service.

You can perform the following functions with Pelican:

* Compose content in Markdown_ or reStructuredText_ using your editor of choice
* Simple command-line tool (re)generates HTML, CSS, and JS from your source content
* Easy to interface with version control systems and web hooks
* Completely static output is simple to host anywhere


Features
--------

Pelican’s feature highlights include:

* Chronological content (e.g., articles, blog posts) as well as static pages
* Integration with external services
* Site themes (created using Jinja2_ templates)
* Publication of articles in multiple languages
* Generation of Atom and RSS feeds
* Code syntax highlighting via Pygments_
* Import existing content from WordPress, Dotclear, or RSS feeds
* Fast rebuild times due to content caching and selective output writing
* Extensible via a rich plugin ecosystem: `Pelican Plugins`_

Check out the `Pelican documentation`_ for further information.


How to get help, contribute, or provide feedback
------------------------------------------------

See our `contribution submission and feedback guidelines `_.


Source code
-----------

Pelican’s source code is `hosted on GitHub`_. For information on how it works,
have a look at `Pelican's internals`_.


Why the name “Pelican”?
-----------------------

“Pelican” is an anagram of *calepin*, which means “notebook” in French.


.. Links

.. _Python: https://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Markdown: https://daringfireball.net/projects/markdown/
.. _Jinja2: https://palletsprojects.com/p/jinja/
.. _Pygments: https://pygments.org/
.. _`Pelican Plugins`: https://github.com/pelican-plugins
.. _`Pelican documentation`: https://docs.getpelican.com/
.. _`Pelican's internals`: https://docs.getpelican.com/en/latest/internals.html
.. _`hosted on GitHub`: https://github.com/getpelican/pelican

.. |build-status| image:: https://img.shields.io/github/actions/workflow/status/getpelican/pelican/main.yml?branch=main
   :target: https://github.com/getpelican/pelican/actions/workflows/main.yml?query=branch%3Amain
   :alt: GitHub Actions CI: continuous integration status
.. |pypi-version| image:: https://img.shields.io/pypi/v/pelican.svg
   :target: https://pypi.org/project/pelican/
   :alt: PyPI: the Python Package Index
.. |downloads| image:: https://img.shields.io/pypi/dm/pelican.svg
   :target: https://pypi.org/project/pelican/
   :alt: Monthly Downloads from PyPI
.. |repology| image:: https://repology.org/badge/tiny-repos/pelican.svg
   :target: https://repology.org/project/pelican/versions
   :alt: Repology: the packaging hub

Owner

Name: Pelican dev team
Login: getpelican
Kind: organization
Email: authors getpelican com

Website: http://getpelican.com/
Repositories: 8
Profile: https://github.com/getpelican

GitHub Events

Total

Create event: 10
Release event: 2
Issues event: 31
Watch event: 530
Delete event: 7
Issue comment event: 185
Push event: 31
Gollum event: 16
Pull request review comment event: 25
Pull request event: 56
Pull request review event: 65
Fork event: 43

Last Year

Create event: 10
Release event: 2
Issues event: 31
Watch event: 530
Delete event: 7
Issue comment event: 185
Push event: 31
Gollum event: 16
Pull request review comment event: 25
Pull request event: 56
Pull request review event: 65
Fork event: 43

Committers

Last synced: 9 months ago

All Time

Total Commits: 2,869
Total Committers: 473
Avg Commits per committer: 6.066
Development Distribution Score (DDS): 0.831

Past Year

Commits: 100
Committers: 27
Avg Commits per committer: 3.704
Development Distribution Score (DDS): 0.69

Top Committers

Name	Email	Commits
Justin Mayer	e**p@g**m	486
Alexis Métaireau	a**s@n**g	434
Deniz Turgut	d**t@g**m	112
Bruno Binet	b**t@g**m	90
W. Trevor King	w**g@t**s	68
Simon Conseil	c**t@s**g	63
derwinlu	d**t@g**m	57
Skami18	s**i@s**g	43
tBunnyMan	W**l@M**m	39
MinchinWeb	w**n@h**m	38
boxydog	b****g	32
Dave Mankoff	m**d@g**m	30
Ondrej Grover	o**r@g**m	29
Simon Liedtke	l**n@g**m	27
Kyle Fuller	i**x@k**k	27
Jorge Maldonado Ventura	j**e@f**t	26
Andrea Crotti	a**0@g**m	23
Vladimír Vondruš	m**a@c**z	22
Oliver Urs Lenz	o**z@g**m	22
botpub	b**b@a**s	19
Rogdham	c**t@r**t	18
Alexander Artemenko	s**t@g**m	18
Kevin Yap	me@k****a	15
jawher	j**a@g**m	15
Bernhard Scheirle	b**t@s**e	14
Massimo Santini	s**i@d**t	13
Guillaume	g**e@l**m	12
Lioman	d**v@l**e	12
FELD Boris	l**n@g**m	12
Nicolas Duhamel	n**s@j**r	12
and 443 more...

Committer Domains (Top 20 + Academic)

me.com: 2 lavabit.com: 2 softwire.com: 2 baslab.org: 1 it-loops.com: 1 yanovich.net: 1 126.com: 1 duif.net: 1 ryanmo.co: 1 server.fake: 1 joeshaw.org: 1 d12s.fr: 1 willthong.com: 1 michaeljaylissner.com: 1 drnik.org: 1 tutamail.com: 1 reagle.org: 1 agilitynerd.com: 1 ziade.org: 1 traeblain.com: 1 uni-bremen.de: 1 u.northwestern.edu: 1 mcs.anl.gov: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 223
Total pull requests: 210
Average time to close issues: 10 months
Average time to close pull requests: 6 months
Total issue authors: 160
Total pull request authors: 82
Average comments per issue: 4.96
Average comments per pull request: 2.57
Merged pull requests: 144
Bot issues: 0
Bot pull requests: 7

Past Year

Issues: 25
Pull requests: 50
Average time to close issues: 15 days
Average time to close pull requests: 17 days
Issue authors: 23
Pull request authors: 24
Average comments per issue: 3.16
Average comments per pull request: 1.82
Merged pull requests: 37
Bot issues: 0
Bot pull requests: 3

View more stats

Top Authors

Issue Authors

egberts (19)
GiovanH (6)
mpaglia0 (5)
boxydog (5)
DragonSerW (4)
sebbASF (4)
mateuszpawlik (3)
justinmayer (3)
FriedrichFroebel (3)
copperchin (3)
shirooo39 (2)
datatalking (2)
vkuehn (2)
paulocoutinhox (2)
ployt0 (2)

Pull Request Authors

boxydog (33)
egberts (13)
justinmayer (13)
avaris (12)
lioman (11)
dependabot[bot] (10)
MinchinWeb (8)
mart-e (8)
pauloxnet (7)
seanh (7)
clockback (6)
GeorgeHu6 (6)
frederik-elwert (6)
snosratiershad (6)
holden-nelson (5)

Top Labels

Issue Labels

bug (62) enhancement (54) question (42) docs (22) stale (4) good first issue (2) awaiting user feedback (2) needs more work (1)

Pull Request Labels

awaiting review (12) dependencies (10) github_actions (8) scrapped (6) needs conflict resolution (5) needs more work (4) in progress (3) manual merge (2) docs (2) python (2)

Packages

Total packages: 1
Total downloads:
- pypi 58,766 last-month
Total docker downloads: 11,469

Total dependent packages: 54
Total dependent repositories: 3,322
Total versions: 64
Total maintainers: 5

pypi.org: pelican

Static site generator supporting Markdown and reStructuredText

Homepage: https://getpelican.com
Documentation: https://docs.getpelican.com
License: AGPLv3
Latest release: 4.11.0
published about 1 year ago

Versions: 64
Dependent Packages: 54
Dependent Repositories: 3,322
Downloads: 58,766 Last month
Docker Downloads: 11,469

Rankings

Stargazers count: 0.2%

Dependent repos count: 0.2%

Dependent packages count: 0.3%

Forks count: 0.4%

Average: 0.8%

Docker downloads count: 1.4%

Downloads: 2.1%

Maintainers (5)

pelicanteam autopub jmayer avaris kylef

Funding

https://donate.getpelican.com/

Last synced: 6 months ago

Dependencies

pyproject.toml pypi

BeautifulSoup4 ^4.9 develop
black ^19.10b0 develop
flake8 ^3.8 develop
flake8-import-order ^0.18.1 develop
invoke ^1.3 develop
isort ^5.2 develop
jinja2 ~2.11 develop
livereload ^2.6 develop
lxml ^4.3 develop
markdown ~3.3.4 develop
psutil ^5.7 develop
pygments ~2.8 develop
pytest ^6.0 develop
pytest-cov ^2.8 develop
pytest-pythonpath ^0.7.3 develop
pytest-sugar ^0.9.4 develop
pytest-xdist ^2.0 develop
sphinx <4.4.0 develop
sphinx_rtd_theme ^0.5 develop
tox ^3.13 develop
typogrify ^2.0 develop
blinker >=1.4
docutils >=0.16
feedgenerator >=1.9
jinja2 >=2.7
markdown >=3.1
pygments >=2.6
python ^3.6
python-dateutil >=2.8
pytz >=2020.1
rich >=10.1
unidecode >=1.1

requirements/docs.pip pypi

livereload *
sphinx <4.4.0
sphinx_rtd_theme *

requirements/owner.pip pypi

tox *
wheel *

requirements/style.pip pypi

flake8 *
flake8-import-order *

requirements/test.pip pypi

BeautifulSoup4 *
Markdown ==3.3.4
Pygments ==2.8.1
lxml *
pytest *
pytest-cov *
pytest-xdist *
typogrify *

.github/workflows/main.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
r-lib/actions/setup-pandoc v2 composite