Initial project (#1)

initial project setup for testing, building, linting, documentation, simple-syslog-grammar/antlr support

Author: ottobackwards

.darglint

@@ -0,0 +1,2 @@
+[darglint]
+strictness=short

.flake8

@@ -0,0 +1,10 @@
+[flake8]
+application-import-names = simple_syslog,tests
+select = B,B9,BLK,C,D,DAR,E,F,I,S,W
+ignore = E203,W503,E501,D100
+max-line-length = 88
+max-complexity = 10
+docstring-convention = google
+
+exclude =
+    generated,

.github/workflows/tests.yml

@@ -0,0 +1,19 @@
+name: Tests
+on: push
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9']
+    name: Python ${{ matrix.python-version }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+        architecture: x64
+    - run: pip install nox==2022.8.7
+    - run: pip install nox-poetry==1.0.1
+    - run: pip install poetry==1.1.14
+    - run: nox --python ${{ matrix.python-version }}

.gitignore

@@ -1,3 +1,7 @@
+# local copy of the generate script ( modified )
+generate.sh
+# jenv
+.java-version
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -127,3 +131,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# idea
+.idea/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "simple_syslog/grammars"]
+	path = simple_syslog/grammars
+	url = https://github.com/palindromicity/simple-syslog-grammars.git

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+        exclude: ^simple_syslog/generated/
+    -   id: trailing-whitespace
+        exclude: ^simple_syslog/generated/
+-   repo: local
+    hooks:
+    -   id: black
+        exclude: ^simple_syslog/generated/
+        name: black
+        entry: poetry run black
+        language: system
+        types: [python]
+    -   id: flake8
+        exclude: ^simple_syslog/generated/
+        name: flake8
+        entry: poetry run flake8
+        language: system
+        types: [ python ]
+    -   id: isort
+        exclude: ^simple_syslog/generated/
+        name: isort (python)
+        entry: poetry run isort
+        language: system
+        types: [ python ]

README.md

@@ -1,2 +1,26 @@
+<!--
+     Copyright 2022 simple-syslog authors
+     All rights reserved.
+     Licensed under the Apache License, Version 2.0 (the "License");
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at
+
+           http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an "AS IS" BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License. Copyright 2022 simple-syslog authors
+     All rights reserved.
+-->
+[![Tests](https://github.com/palindromicity/simple-syslog-python/workflows/Tests/badge.svg)](https://github.com/palindromicity/simple-syslog-python/actions?workflow=Tests)
+
 # simple-syslog-python
 Python 3 Implementation of simple-syslog
+
+poetry
+nox
+nox-poetry
+
+generate.sh.local

docs/conf.py

@@ -0,0 +1,9 @@
+"""Sphinx configuration."""
+project = "simple-syslog"
+author = "Otto Fowler"
+copyright = f"2022, {author}"
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+]

docs/index.rst

@@ -0,0 +1,21 @@
+simple-syslog
+==============================
+Description
+
+
+Installation
+------------
+
+To install the Hypermodern Python project,
+run this command in your terminal:
+
+.. code-block:: console
+
+   $ pip install simple-syslog
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   license
+   reference

docs/license.rst

@@ -0,0 +1,4 @@
+License
+=======
+
+.. include:: ../LICENSE