Modernize

.gitignore

@@ -43,3 +43,4 @@ env*/
 *.sublime-workspace
 
 test-site/output/*
+poetry.lock

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+---
+# See https://pre-commit.com/hooks.html for info on hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: forbid-new-submodules
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 21.4b0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 3.9.1
+    hooks:
+      - id: flake8
+        args: [--max-line-length=88]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.8.0
+    hooks:
+      - id: isort

CHANGELOG.rst

@@ -1,13 +1,45 @@
 NoJekyll Changelog
-=======================
-
-This Changelog is for ``minchin.pelican.plugins.nojekyll``.
-
-- :release:`1.0.2 <2017-04-17>`
-- :bug:`-` add Pelican trove classifier
-- :bug:`-` update release machinery
-- :release:`1.0.1 <2016-09-12>`
-- :bug:`-` fix PEP8 formatting issues
-- :support:`-` add release machinery
-- :release:`1.0.0 <2016-08-13>`
-- :feature:`-` original implementation
+==================
+
+2.0.0
+-----
+
+- **feature** Initial release as namespace plugin. With Pelican 4.5,
+  namespace plugins no longer need to be explicitly declared to be available to
+  Pelican.
+- **support** minimum version of Pelican is now 3.0
+- **support** Move plugin to the `Pelican Plugins`_ organization on GitHub. The
+  code for the project is now at
+  `pelican-plugins/nojekyll`_
+- **support** first release to PyPI under `pelican-nojekyll`_
+- see `Pull Request #3`_.
+
+.. _pelican-nojekyll: https://pypi.org/project/pelican-nojekyll/
+.. _Pelican Plugins: https://github.com/pelican-plugins/
+.. _pelican-plugins/nojekyll: https://github.com/pelican-plugins/nojekyll/
+.. _Pull Request #3: https://github.com/pelican-plugins/nojekyll/pull/3
+
+1.1.0 - 2021-06-01
+------------------
+
+- **feature** add logging
+
+1.0.2 - 2017-04-17
+------------------
+
+- **bug** add Pelican trove classifier
+- **bug** update release machinery
+
+1.0.1 - 2016-09-12
+------------------
+
+- **bug** fix PEP8 formatting issues
+- **support** add release machinery
+
+1.0.0 - 2016-08-13
+------------------
+
+- **feature** original implementation
+- **support** first release to PyPI under `minchin.pelican.plugins.nojekyll`_
+
+.. _minchin.pelican.plugins.nojekyll: https://pypi.org/project/minchin.pelican.plugins.nojekyll/

CONTRIBUTING.md

@@ -0,0 +1,12 @@
+Contributing
+============
+
+Contributions 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 on [existing issues][].
+
+To start contributing to this plugin, review the [Contributing to Pelican][]
+documentation, beginning with the **Contributing Code** section.
+
+[existing issues]: https://github.com/pelican-plugins/minchin.pelican.plugins.nojekyll/issues
+[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html

Licence.txt → LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 William Minchin
+Copyright (c) 2016, 2017, 2021 William Minchin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -2,36 +2,51 @@
 NoJekyll
 ========
 
+|build| |pypi|
+
+.. |build| image:: https://img.shields.io/github/workflow/status/pelican-plugins/nojekyll/build
+    :target: https://github.com/pelican-plugins/nojekyll/actions
+    :alt: Build Status
+
+.. |pypi| image:: https://img.shields.io/pypi/v/pelican-nojekyll.svg
+    :target: https://pypi.python.org/pypi/pelican-nojekyll
+    :alt: PyPI Version
+
 ``NoJekyll`` is a plugin for `Pelican <http://docs.getpelican.com/>`_,
 a static site generator written in Python.
 
 ``NoJekyll`` creates a *.nojekyll* file in the root of your output directory.
 This is useful when you are publishing your site to
 `GitHub Pages <https://pages.github.com/>`_ as it keeps your site from being
-run through GitHub's defualt Jekyll site generator. This has a side effect
+run through GitHub's default Jekyll site generator. This has a side effect
 of make your updated site go live faster.
 
 
 Installation
 ============
 
-The easiest way to install ``NoJekyll`` is through the use of pip. This
-will also install the required dependencies automatically.
+The easiest way to install ``NoJekyll`` is through the use of pip. This will
+also install the required dependencies (currently just ``pelican``)
+automatically.
 
 .. code-block:: sh
 
-  pip install minchin.pelican.plugins.nojekyll
+  pip install pelican-nojekyll
+
+As ``NoJekyll`` is a namespace plugin, assuming you are using Pelican 4.5
+(or newer) **and** *only* other namespace plugins, ``NoJekyll`` will be
+automatically be loaded by Pelican. And that's it!
 
-Then, in your ``pelicanconf.py`` file, add ``NoJekyll`` to your list of
-plugins:
+If you are using an older version of Pelican, or non-namespace plugins, you may
+need to add ``NoJekyll`` to your ``pelicanconf.py``:
 
 .. code-block:: python
 
   PLUGINS = [
-              # ...
-              'minchin.pelican.plugins.nojekyll',
-              # ...
-            ]
+      # ...
+      "pelican.plugins.nojekyll",
+      # ...
+  ]
 
 And that's it! No further configuration is needed.
 

minchin/pelican/plugins/nojekyll.py → pelican/plugins/nojekyll/__init__.py

@@ -11,7 +11,7 @@
 
 from pelican import signals
 
-__version__ = "1.0.3-dev"
+__version__ = "2.0.0-dev"
 
 logger = logging.getLogger(__name__)
 

pyproject.toml

@@ -0,0 +1,82 @@
+[tool.poetry]
+name = "pelican-nojekyll"
+version = "2.0.0-dev"
+description = "Pelican plugin that adds a ``.nojekyll`` file to the output root. Useful for publishing to Github Pages. Written in Python."
+authors = ["William Minchin <w_minchin@hotmail.com>"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+python = "^3.6.2 || ^3.7"
+pelican = "^3 || ^4"
+
+[tool.poetry.dev-dependencies]
+black = {version = "^21.4b0", allow-prereleases = true}
+flake8 = "^3.8"
+invoke = "^1.3"
+isort = "^5.4"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+
+readme = "README.rst"
+keywords = ["GitHub pages", "pelican", "plugin"]
+repository = "https://github.com/pelican-plugins/nojekyll"
+documentation = "https://github.com/pelican-plugins/nojekyll/master/README.rst"
+packages = [
+    { include = "pelican" },
+]
+include = [
+    "README.rst",
+    "LICENSE.txt",
+    "CHANGELOG.rst",
+    "CONTRIBUTING.md",
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Framework :: Pelican",
+    "Framework :: Pelican :: Plugins",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[tool.poetry.urls]
+"Funding" = "https://donate.getpelican.com/"
+"Bug Tracker" = "https://github.com/pelican-plugins/nojekyll/issues"
+"Changelog" = "https://github.com/pelican-plugins/nojekyll/master/CHANGELOG.rst"
+
+
+[tool.autopub]
+project-name = "NoJykell"
+git-username = "botpub"
+git-email = "botpub@autopub.rocks"
+changelog-file = "CHANGELOG.rst"
+version-strings = ["pelican/plugins/nojekyll/__init__.py"]
+changelog-header = "======================="
+version-header = "-"
+
+[tool.isort]
+# Maintain compatibility with Black
+profile = "black"
+
+# Sort imports within their section independent of the import type
+force_sort_within_sections = true
+
+# Designate "pelican" as separate import section
+known_pelican = "pelican"
+sections = "FUTURE,STDLIB,THIRDPARTY,PELICAN,FIRSTPARTY,LOCALFOLDER"
+
+[tool.black]
+line-length = 88