{ "info": { "author": "Tim Allen", "author_email": "tallen@wharton.upenn.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 2.0", "Framework :: Wagtail", "Framework :: Wagtail :: 2", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3 :: Only", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "# Peregrine\n\n## Note: Please Read Before Using\n\n**Peregrine will be joining forces with CodeRedCMS. We have similar philosophies: a plug and play system on top of Wagtail using Bootstrap 4. It doesn't make sense to duplicate our efforts.**\n\nWe will keep this repository and PyPI package present for our (very few) users.\n\n**Please see [CodeRedCMS here](https://github.com/coderedcorp/coderedcms).**\n\nPeregrine is an opinionated blogging platform which uses [the Wagtail CMS](https://wagtail.io) on the [Django web framework](https://www.djangoproject.com). It uses Wagtail's fantastic [StreamField feature](http://docs.wagtail.io/en/v1.13/topics/streamfield.html) to provide fully structured content body element blocks, completely separating content from the presentation layer (CSS, JS, and HTML).\n\n*This is alpha software, in active development!*\n\nPeregrine requires at least Wagtail 2.0 and Django 2.0.\n\n## Getting Started: the Five Minute Install\n\nThese instructions will be fleshed out, but if you want to give it a try, here are the basics.\n\n### System\n\n```shell\nmkvirtualenv my_blog\npip install peregrine\ndjango-admin startproject my_blog\ncd my_blog\n```\n\n### Settings\n\nYour 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.\n\n```python\nINSTALLED_APPS = [\n ...\n]\n\nPEREGRINE_APPS = [\n 'peregrine',\n 'bootstrap4',\n 'wagtailcodeblock',\n 'wagtailcontentstream',\n 'taggit',\n 'modelcluster',\n\n 'wagtail.core',\n 'wagtail.admin',\n 'wagtail.documents',\n 'wagtail.snippets',\n 'wagtail.users',\n 'wagtail.images',\n 'wagtail.embeds',\n 'wagtail.search',\n 'wagtail.sites',\n 'wagtail.contrib.settings',\n 'wagtail.contrib.modeladmin',\n 'wagtail.contrib.table_block',\n]\n\nINSTALLED_APPS += PEREGRINE_APPS\n\nMIDDLEWARE = [\n ...\n]\n\nPEREGRINE_MIDDLEWARE = [\n 'wagtail.core.middleware.SiteMiddleware',\n]\n\nMIDDLEWARE += PEREGRINE_MIDDLEWARE\n\nWAGTAIL_SITE_NAME = 'My Blog'\n\n\nTEMPLATES = [\n {\n ...\n\n 'OPTIONS': {\n 'context_processors': [\n ...\n\n 'wagtail.contrib.settings.context_processors.settings',\n ]\n }\n }\n]\n\n```\n\n### URLs\n\n```python\nfrom django.contrib import admin\nfrom django.urls import include, path, re_path\n\nfrom wagtail.admin import urls as wagtailadmin_urls\nfrom wagtail.documents import urls as wagtaildocs_urls\n\nurlpatterns = [\n path('admin/', admin.site.urls),\n\n # Wagtail / Peregrine URLs\n path('documents/', include(wagtaildocs_urls)),\n path('cms/', include(wagtailadmin_urls)),\n re_path(r'^', include('peregrine.urls')),\n]\n```\n\n### Fire it up!\n\nAfter you've set up your settings, we need to create your database and a superuser. Issue the following commands from your project root directory.\n\n*Only run the command `peregrine_initial_site` if you are running on a new project, as it loads database fixtures!*\n\n\n```shell\npython manage.py migrate\n# ** Be sure to see the note above before running this next command. It isn't necessary if you don't want to. **\npython manage.py peregrine_initial_site\npython manage.py createsuperuser\npython manage.py runserver 0:8000\n```\n\nYou should then be able to navigate to http://localhost:8000/cms/ and log in, and start creating!\n\n## Release Notes\n\n### 0.2.2\n\n* Switch the menus to pull any non-post pages tagged for inclusion in menus, rather than just pages of type `SitePage`.\n\n### 0.2.1\n\n* Add a `VACUUM` command if running SQLite on S3 as the default database engine to keep the SQLite DB size as small as possible.\n\n### 0.2.0\n\n* Add new setting to only keep recent revisions. If not set, will keep all revisions.\n\n## Maintainer\n\n* Timothy Allen (https://github.com/FlipperPA/)\n\n## Contributors\n\n* Jon Banafato (https://github.com/jonafato/)\n* Rana Fayez (https://github.com/meetRanaFayez/)\n* Jeff Triplett (https://github.com/jefftriplett/)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/FlipperPA/peregrine", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "peregrine", "package_url": "https://pypi.org/project/peregrine/", "platform": "", "project_url": "https://pypi.org/project/peregrine/", "project_urls": { "Homepage": "https://github.com/FlipperPA/peregrine" }, "release_url": "https://pypi.org/project/peregrine/0.2.4/", "requires_dist": [ "wagtail (>=2.0)", "wagtailcontentstream (>=0.4.0)", "django-bootstrap4 (>=0.0.7)" ], "requires_python": "", "summary": "Peregrine is an opinioned blog system for the Wagtail content management system on the Django Web Framework.", "version": "0.2.4" }, "last_serial": 4631807, "releases": { "0.1": [], "0.2.3": [ { "comment_text": "", "digests": { "md5": "71408e1a50ebcee70d26a9989f2d49d9", "sha256": "a4fe9d13b8a73f5c8749adc1cd5b91a7f2f4834910e520dadaf4fea2912c7ada" }, "downloads": -1, "filename": "peregrine-0.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "71408e1a50ebcee70d26a9989f2d49d9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28396, "upload_time": "2018-11-12T16:57:05", "url": "https://files.pythonhosted.org/packages/91/0f/f1b8f2b4d1ebc1a6e519bf44f5a54c68163de39f5503359e80c43f0bb9cb/peregrine-0.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fa99d7ec7a32b55660a7e1bd0fdffcb6", "sha256": "b8fb5f518de7a12ebf7edec43dac538e6278b9c651477d81a15feba406bdd707" }, "downloads": -1, "filename": "peregrine-0.2.3.tar.gz", "has_sig": false, "md5_digest": "fa99d7ec7a32b55660a7e1bd0fdffcb6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16751, "upload_time": "2018-11-12T16:57:06", "url": "https://files.pythonhosted.org/packages/8b/2f/5f09e629bfd4c12099eddfa072df2dc66738543f2d8d6000c37ee49efe80/peregrine-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "0ea98ec04e3f944b05198d9492226859", "sha256": "3904dd61e5414fa5253bbb01b9a5209436d76f483038c9217f11a423d2b81468" }, "downloads": -1, "filename": "peregrine-0.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "0ea98ec04e3f944b05198d9492226859", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 29567, "upload_time": "2018-12-24T16:49:07", "url": "https://files.pythonhosted.org/packages/9b/28/90b499a49ff58370515ec5be047bfb5eb24cfde407b01d5ce68ef37360a0/peregrine-0.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1e8f71f1a4273500ad244e7a1ead1c34", "sha256": "1f6b61d941d50944771275615e692cd9f4a5dd72e6ba99f0de7fdb95d579143e" }, "downloads": -1, "filename": "peregrine-0.2.4.tar.gz", "has_sig": false, "md5_digest": "1e8f71f1a4273500ad244e7a1ead1c34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16961, "upload_time": "2018-12-24T16:49:08", "url": "https://files.pythonhosted.org/packages/6d/bc/179d6592bb482476d1d26302d73cac61e6005eac7c00ce313ee3a0292ad1/peregrine-0.2.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0ea98ec04e3f944b05198d9492226859", "sha256": "3904dd61e5414fa5253bbb01b9a5209436d76f483038c9217f11a423d2b81468" }, "downloads": -1, "filename": "peregrine-0.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "0ea98ec04e3f944b05198d9492226859", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 29567, "upload_time": "2018-12-24T16:49:07", "url": "https://files.pythonhosted.org/packages/9b/28/90b499a49ff58370515ec5be047bfb5eb24cfde407b01d5ce68ef37360a0/peregrine-0.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1e8f71f1a4273500ad244e7a1ead1c34", "sha256": "1f6b61d941d50944771275615e692cd9f4a5dd72e6ba99f0de7fdb95d579143e" }, "downloads": -1, "filename": "peregrine-0.2.4.tar.gz", "has_sig": false, "md5_digest": "1e8f71f1a4273500ad244e7a1ead1c34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16961, "upload_time": "2018-12-24T16:49:08", "url": "https://files.pythonhosted.org/packages/6d/bc/179d6592bb482476d1d26302d73cac61e6005eac7c00ce313ee3a0292ad1/peregrine-0.2.4.tar.gz" } ] }