Initial Commit

Author: rumpelsepp

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/linters.yml

@@ -0,0 +1,45 @@
+name: linters
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    paths:
+    - 'exitcode'
+    - 'poetry.lock'
+    - '.github/**'
+    - 'tests/**'
+
+jobs:
+  linters:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11']
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: Gr1N/setup-poetry@v8
+    - uses: actions/cache@v3
+      with:
+        path: ~/.cache/pypoetry/virtualenvs
+        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+
+    - name: Install Dependencies
+      run: |
+        poetry install
+    - name: Run ruff
+      run: |
+        poetry run ruff check exitcode
+    - name: Run mypy
+      run: |
+        poetry run mypy exitcode
+    - name: Run black
+      run: |
+        poetry run black --check --verbose exitcode

.github/workflows/python-publish.yml

@@ -0,0 +1,36 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - uses: Gr1N/setup-poetry@v8
+    - uses: actions/cache@v3
+      with:
+        path: ~/.cache/pypoetry/virtualenvs
+        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+
+    - name: Install Dependencies
+      run: |
+        poetry install
+    - name: Build package
+      run: |
+        poetry build
+    - name: Publish a Python distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) Stefan Tatschner <stefan@rumpelsepp.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,15 @@
+# exitcode
+
+Preferred system exit codes as defined by [`sysexits.h`](https://man.openbsd.org/sysexits).
+This library is inspired by this [rust library](https://docs.rs/exitcode).
+
+## Example
+
+All constants from the manpage [sysexits(3)](https://man.openbsd.org/sysexits) are available without the `EX_` prefix.
+
+``` python
+import exitcode
+import sys
+
+sys.exit(exitcode.OK)
+```

exitcode/__init__.py

@@ -0,0 +1,83 @@
+# SPDX-FileCopyrightText: Stefan Tatschner
+#
+# SPDX-License-Identifier: MIT
+#
+# Preferred system exit codes as defined by sysexits.h
+#
+# Exit code constants intended to be passed to `sys.exit()`;
+# inspired by https://docs.rs/exitcode.
+
+# Successful exit
+OK = 0
+
+# The command was used incorrectly, e.g., with the
+# wrong number of arguments, a bad flag, a bad syntax
+# in a parameter, etc.
+USAGE = 64
+
+# The input data was incorrect in some way.  This
+# should only be used for user's data and not system
+# files.
+DATAERR = 65
+
+# An input file (not a system file) did not exist or
+# was not readable.  This could also include errors
+# like "No message" to a mailer (if it cared to
+# catch it).
+NOINPUT = 66
+
+# The user specified did not exist.  This might be
+# used for mail addresses or remote logins.
+NOUSER = 67
+
+# The host specified did not exist.  This is used in
+# mail addresses or network requests.
+NOHOST = 68
+
+# A service is unavailable.  This can occur if a
+# support program or file does not exist. This can also
+# be used as a catchall message when something you
+# wanted to do doesn't work, but you don't know why.
+UNAVAILABLE = 69
+
+# An internal software error has been detected.  This
+# should be limited to non-operating system related
+# errors as possible.
+SOFTWARE = 70
+
+# An operating system error has been detected.  This
+# is intended to be used for such things as "cannot
+# fork", "cannot create pipe", or the like.  It
+# includes things like getuid returning a user that
+# does not exist in the passwd file.
+OSERR = 71
+
+# Some system file (e.g., /etc/passwd, /var/run/utmp,
+# etc.) does not exist, cannot be opened, or has some
+# sort of error (e.g., syntax error).
+OSFILE = 72
+
+# A (user specified) output file cannot be created.
+CANTCREAT = 73
+
+# An error occurred while doing I/O on some file.
+IOERR = 74
+
+# Temporary failure, indicating something that is not
+# really an error.  In sendmail, this means that a
+# mailer (e.g.) could not create a connection, and
+# the request should be reattempted later.
+TEMPFAIL = 75
+
+# The remote system returned something that was
+# "not possible" during a protocol exchange.
+PROTOCOL = 76
+
+# You did not have sufficient permission to perform
+# the operation.  This is not intended for file system
+# problems, which should use `NOINPUT` or `CANTCREAT`,
+# but rather for higher level permissions.
+NOPERM = 77
+
+# Something was found in an unconfigured or misconfigured state.
+CONFIG = 78

exitcode/py.typed

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: AISEC Pentesting Team
+#
+# SPDX-License-Identifier: CC0-1.0
+
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs";
+  };
+
+  outputs = { self, nixpkgs }:
+    with import nixpkgs { system = "x86_64-linux"; };
+    let pkgs = nixpkgs.legacyPackages.x86_64-linux;
+    in {
+      devShell.x86_64-linux = pkgs.mkShell {
+        buildInputs = with pkgs; [ 
+          poetry
+          python310
+          python311
+        ];
+        shellHook = ''
+          LD_LIBRARY_PATH=${pkgs.lib.makeLibraryPath [stdenv.cc.cc]}
+        '';
+      };
+      formatter.x86_64-linux = pkgs.nixpkgs-fmt;
+    };
+}