Release 1.0.0 (#58)

* Fix minor doc typo

"Litaral" -> "Literal"

* Switched broken pypip.in badges to shields.io

* Updating cli docs

* add funding button

* Add nix shell, confirm works on Python 3.9

* Shell, python310

* remove python2 from CI

* Switch CI

* add requires.io badge

* switch to pytest, forget python2

* pytest

* fix rst tests

* install stylus before tests

* f

* fix coveralls

* add coverage

* Version bump

* changelog

* incorporate Pull request #55

Co-authored-by: Tom X. Tobin <[email protected]>
Co-authored-by: Michael Overmeyer <[email protected]>
Co-authored-by: Stephen <[email protected]>

Author: 4 people

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [avanov]

.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: "CI"
+on:
+  push:
+    branches: [ master, develop ]
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        python-version: [ 39, 310 ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          submodules: recursive
+      - uses: cachix/install-nix-action@v12
+        with:
+          install_url: https://releases.nixos.org/nix/nix-2.11.1/install
+          extra_nix_config: "system-features = benchmark kvm"
+      - name: Run tests on Python${{ matrix.python-version }}
+        run: |
+          nix-shell --argstr pyVersion ${{ matrix.python-version }} --run \
+          "pip install -e . && pip install -r requirements.txt && pip install -r requirements-test.txt && python -m pytest"
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          nix-shell --argstr pyVersion ${{ matrix.python-version }} --run "coveralls --service=github"
+
+  coveralls:
+    name: Coveralls [finalize]
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          submodules: recursive
+      - uses: cachix/install-nix-action@v12
+        with:
+          install_url: https://releases.nixos.org/nix/nix-2.11.1/install
+          extra_nix_config: "system-features = benchmark kvm"
+      - name: Coveralls [finalize]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          nix-shell --run "coveralls --service=github --finish"

.gitignore

@@ -7,6 +7,11 @@
 build/
 dist/
 *.egg-info/
+*.eggs/
+*.local/
+__pycache__/
+# npm package lock, we don't need it as the 'stylus' dependency is optional
+package-lock.json
 
 docs/_build
 

.travis.yml

@@ -1,6 +1,13 @@
 Changelog
 ================
 
+1.0.0
+-----
+
+- Dropped support for Python 2.x
+- Test suite switched from Nose to Pytest
+- CI switched from Travis CI to Github Actions
+
 Version 0.9
 -------------
 

CHANGES

@@ -1,20 +1,21 @@
 Plim
 ==============
 
-.. image:: https://pypip.in/v/Plim/badge.png
+.. image:: https://img.shields.io/pypi/v/Plim.svg
         :target: https://crate.io/packages/Plim
 
-.. image:: https://pypip.in/d/Plim/badge.png
-        :target: https://crate.io/packages/Plim
+.. image:: https://requires.io/github/avanov/Plim/requirements.svg?branch=master
+    :target: https://requires.io/github/avanov/Plim/requirements/?branch=master
+    :alt: Requirements Status
 
-.. image:: https://api.travis-ci.org/avanov/Plim.png
-        :target: https://travis-ci.org/avanov/Plim
+.. image:: https://img.shields.io/pypi/dm/Plim.svg
+        :target: https://crate.io/packages/Plim
 
-.. image:: https://coveralls.io/repos/avanov/Plim/badge.png?branch=develop
-        :target: https://coveralls.io/r/avanov/Plim?branch=develop
+.. image:: https://github.com/avanov/Plim/workflows/CI/badge.svg?branch=develop
+    :target: https://github.com/avanov/Plim/actions?query=branch%3Adevelop
 
-.. image:: https://gemnasium.com/avanov/Plim.svg
-        :target: https://gemnasium.com/avanov/Plim
+.. image:: https://coveralls.io/repos/github/avanov/Plim/badge.svg?branch=develop
+    :target: https://coveralls.io/github/avanov/Plim?branch=develop
 
 
 Plim is a Python port of `Ruby's Slim template language <http://slim-lang.com/>`_

README.rst

@@ -0,0 +1,67 @@
+# https://nixos.wiki/wiki/Development_environment_with_nix-shell
+{   pkgs            ? (import ./nixpkgs).pkgs
+,   pyVersion       ? "310"
+}:
+
+let
+
+python = pkgs."python${pyVersion}Full";
+pythonPkgs = pkgs."python${pyVersion}Packages";
+
+devEnv = pkgs.mkShellNoCC {
+     name = "plim-devenv";
+
+     # The packages in the `buildInputs` list will be added to the PATH in our shell
+     # Python-specific guide:
+     # https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/python.section.md
+     nativeBuildInputs = with pkgs; [
+         # see https://nixos.org/nixos/packages.html
+         # Python distribution
+         python
+         pythonPkgs.virtualenv
+         pythonPkgs.wheel
+         pythonPkgs.twine
+         pythonPkgs.coveralls
+
+         nodejs
+         nodePackages.npm
+         taglib
+         ncurses
+         libxml2
+         libxslt
+         libzip
+         zlib
+         # root CA certificates
+         cacert
+         which
+     ];
+     shellHook = ''
+         # set SOURCE_DATE_EPOCH so that we can use python wheels
+         export SOURCE_DATE_EPOCH=$(date +%s)
+
+         VENV_DIR=$PWD/.venv
+
+         export PATH=$VENV_DIR/bin:$PATH
+         export PYTHONPATH=""
+         export LANG=en_GB.UTF-8
+
+         # https://python-poetry.org/docs/configuration/
+         export PIP_CACHE_DIR="$PWD/.local/pip-cache${pyVersion}"
+
+         # Setup virtualenv
+         if [ ! -d $VENV_DIR ]; then
+             virtualenv $PWD/.venv
+             $VENV_DIR/bin/python -m pip install -e $PWD
+             $VENV_DIR/bin/python -m pip install -r $PWD/requirements.txt
+         fi
+
+         if [ ! -d $PWD/node_modules ]; then
+             npm install stylus
+         fi
+     '';
+};
+
+in
+{
+    inherit devEnv;
+}

default.nix

@@ -9,15 +9,22 @@ source files into Mako templates.
 .. code-block:: shell
 
     $ plimc -h
-    usage: plimc [-h] [--encoding ENCODING] source target
+    usage: plimc [-h] [-o OUTPUT] [-e ENCODING] [-p PREPROCESSOR] [-H] [-V] source
 
     Compile plim source files into mako files.
 
     positional arguments:
       source               path to source plim template
-      target               path to target mako template
 
     optional arguments:
       -h, --help           show this help message and exit
-      --encoding ENCODING  source file encoding
+      -o OUTPUT, --output OUTPUT
+                           write result to FILE.
+      -e ENCODING, --encoding ENCODING
+                           content encoding
+      -p PREPROCESSOR, --preprocessor PREPROCESSOR
+                           Preprocessor instance that will be used for parsing
+                           the template
+      -H, --html           Render HTML output instead of Mako template
+      -V, --version        show program's version number and exit
 

docs/cli.rst

@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.9'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.9.12'
+release = '1.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -61,7 +61,7 @@ Plim is *not the exact* port of Slim. Here is the full list of differences.
 #.  In Plim, all html tags **MUST** be written in lowercase.
 
     This restriction was introduced to support
-    :ref:`Implicit Litaral Blocks <implicit-literals>` feature.
+    :ref:`Implicit Literal Blocks <implicit-literals>` feature.
 
     .. code-block:: slim