peregrine

Peregrine is an opinionated blog for Wagtail and Django.

https://github.com/flipperpa/peregrine

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
1 of 6 committers (16.7%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (8.7%) to scientific vocabulary

Last synced: 10 months ago · JSON representation

Repository

Peregrine is an opinionated blog for Wagtail and Django.

Basic Info

Host: GitHub
Owner: FlipperPA
License: bsd-3-clause
Language: Python
Default Branch: main
Size: 148 KB

Statistics

Stars: 48
Watchers: 9
Forks: 11
Open Issues: 5
Releases: 4

Created over 8 years ago · Last pushed over 1 year ago

Metadata Files

Readme License

Peregrine

Peregrine is an opinionated blogging platform which uses the Wagtail CMS on the Django web framework and is geared for coding blogs. It uses Wagtail's fantastic StreamField feature to provide fully structured content body element blocks, completely separating content from the presentation layer (CSS, JS, and HTML).

It uses Wagtail Code Block with PrismJS syntax highlighting under the hood for beautiful code snippets. You can see this in action at PyPhilly.org.

Are you looking for a more robust system, for example, creating a marketing site? The maintainer of Peregrine also contributes to CodeRedCMS, which offers a lot more bells and whistles. Peregrine will remain a basic weblog solutions focused on features to display code.

Getting Started: the Five Minute Install

These instructions will be fleshed out, but if you want to give it a try, here are the basics.

System

shell mkvirtualenv my_blog pip install peregrine django-admin startproject my_blog cd my_blog

Settings

Your settings file will be located in my_blog/settings.py if you're using the default Django project layout created by the startproject command above. You'll need to add the sections beneath INSTALLED_APPS and MIDDLEWARE, and add 'wagtail.contrib.settings.context_processors.settings', to your TEMPLATES context processors in your settings to look like this.

```python INSTALLED_APPS = [ ... ]

PEREGRINE_APPS = [ "peregrine", "bootstrap4", "wagtailcodeblock", "wagtailcontentstream",

"wagtail.contrib.forms",
"wagtail.contrib.redirects",
"wagtail.embeds",
"wagtail.sites",
"wagtail.users",
"wagtail.snippets",
"wagtail.documents",
"wagtail.images",
"wagtail.search",
"wagtail.admin",
"wagtail.core",
"taggit",
"modelcluster",

"wagtail.contrib.settings",
"wagtail.contrib.modeladmin",
"wagtail.contrib.table_block",

]

INSTALLEDAPPS += PEREGRINEAPPS

MIDDLEWARE = [ ... ]

PEREGRINE_MIDDLEWARE = [ "wagtail.contrib.redirects.middleware.RedirectMiddleware", ]

MIDDLEWARE += PEREGRINE_MIDDLEWARE

WAGTAILSITENAME is used by Wagtail; others are used by OpenGraph.

WAGTAILSITENAME = "PyPhilly: Home of FlipperPA" WAGTAILSITEDESCRIPTION = "PyPhilly is the website of Tim Allen, a web developer living in Philadelphia. Tim has a wide range of interests, but mostly writes about Python, Django, and virtual reality." WAGTAILSITEURL = "https://PyPhilly.org/"

TEMPLATES = [ { ...

    'OPTIONS': {
        'context_processors': [
            ...

            'wagtail.contrib.settings.context_processors.settings',
        ]
    }
}

]

```

URLs

```python from django.contrib import admin from django.urls import include, path, re_path

from wagtail.admin import urls as wagtailadminurls from wagtail.documents import urls as wagtaildocsurls

urlpatterns = [ path('admin/', admin.site.urls),

# Wagtail / Peregrine URLs
path('documents/', include(wagtaildocs_urls)),
path('cms/', include(wagtailadmin_urls)),
re_path(r'^', include('peregrine.urls')),

] ```

Fire it up!

After you've set up your settings, we need to create your database and a superuser. Issue the following commands from your project root directory.

Only run the command peregrine_initial_site if you are running on a new project, as it loads database fixtures!

```shell python manage.py migrate

Be sure to see the note above before running this next command. It isn't necessary if you don't want to.

python manage.py peregrineinitialsite python manage.py createsuperuser python manage.py runserver 0:8000 ```

You should then be able to navigate to http://localhost:8000/cms/ and log in, and start creating!

Maintainer

Timothy Allen (https://github.com/FlipperPA/)

Contributors

Jon Banafato (https://github.com/jonafato/)
Dave Bauer (https://github.com/tdxdave)
Rana Fayez (https://github.com/Tagine/)
Jeff Triplett (https://github.com/jefftriplett/)

Owner

Name: Timothy Allen
Login: FlipperPA
Kind: user
Location: Philadelphia, PA
Company: The Wharton School: @wharton

Website: https://www.PyPhilly.org
Repositories: 119
Profile: https://github.com/FlipperPA

Principal Engineer, WRDS at The Wharton School. PSF and DSF member. Fan of loud guitar, analog pedals, hockey, and ice cream. He/him. For the Horde!

GitHub Events

Total

Push event: 1
Pull request event: 2
Fork event: 1

Last Year

Push event: 1
Pull request event: 2
Fork event: 1

Committers

Last synced: 12 months ago

All Time

Total Commits: 174
Total Committers: 6
Avg Commits per committer: 29.0
Development Distribution Score (DDS): 0.08

Past Year

Commits: 1
Committers: 1
Avg Commits per committer: 1.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Allen, Timothy	t**n@w**u	160
Dave Bauer	8****e	6
Jeff Triplett	j**t@g**m	3
Fayez, Rana	r**z@g**m	3
Mary Kate Fain	mk@m****m	1
Jon Banafato	j**n@j**m	1

Committer Domains (Top 20 + Academic)

jonafato.com: 1 marykatefain.com: 1 wharton.upenn.edu: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time

Total issues: 7
Total pull requests: 11
Average time to close issues: over 1 year
Average time to close pull requests: 4 months
Total issue authors: 7
Total pull request authors: 6
Average comments per issue: 0.71
Average comments per pull request: 1.36
Merged pull requests: 10
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: 18 days
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

FlipperPA (1)
pavanish (1)
yarosh01 (1)
tdxdave (1)
tagine (1)
SundialServices (1)
onsombal (1)

Pull Request Authors

tdxdave (4)
tagine (3)
jefftriplett (2)
tomdyson (1)
jonafato (1)
marykatefain (1)

Top Labels

Issue Labels

enhancement (1)

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- pypi 113 last-month

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 2
(may contain duplicates)
Total versions: 10
Total maintainers: 2

pypi.org: peregrine

Peregrine is an opinioned blog system for the Wagtail content management system on the Django Web Framework.

Homepage: https://github.com/FlipperPA/peregrine
Documentation: https://peregrine.readthedocs.io/
License: BSD License
Latest release: 0.5.1
published about 4 years ago

Versions: 9
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 92 Last month

Rankings

Stargazers count: 9.5%

Dependent packages count: 10.0%

Forks count: 10.9%

Average: 15.2%

Dependent repos count: 21.7%

Downloads: 24.0%

Maintainers (1)

FlipperPA

Last synced: 11 months ago

pypi.org: wagtail-peregrine

Stub to alias the `peregrine` package.

Homepage: https://github.com/FlipperPA/peregrine
Documentation: https://wagtail-peregrine.readthedocs.io/
License: bsd-3-clause
Latest release: 0.2.3
published over 7 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 21 Last month

Rankings

Stargazers count: 9.5%

Dependent packages count: 10.0%

Forks count: 10.9%

Dependent repos count: 21.7%

Average: 22.0%

Downloads: 58.1%

Maintainers (2)

kalobtaulien FlipperPA

Last synced: 11 months ago

Dependencies

setup.py pypi

django-bootstrap4 >=2
wagtail >=3.0.1,<3.1
wagtailcodeblock <=1.28.0
wagtailcontentstream >=0.4.0

peregrine

Science Score: 36.0%

Repository

Basic Info

Statistics

Metadata Files

README.md

Peregrine

Getting Started: the Five Minute Install

System

Settings

WAGTAILSITENAME is used by Wagtail; others are used by OpenGraph.

URLs

Fire it up!

** Be sure to see the note above before running this next command. It isn't necessary if you don't want to. **

Maintainer

Contributors

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: peregrine

Rankings

Maintainers (1)

pypi.org: wagtail-peregrine

Rankings

Maintainers (2)

Dependencies

Be sure to see the note above before running this next command. It isn't necessary if you don't want to.