From 9e0d5f67b1fc8b3c8e00683ebd380882ad618315 Mon Sep 17 00:00:00 2001 From: Domenic Barbuzzi Date: Wed, 8 Jan 2025 20:14:43 +0000 Subject: [PATCH] wip --- README.md | 16 ++++++++++++++-- tests/__init__.py | 13 +++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb22764..c87770b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ A pytest plugin offering various functionality for Neural Magic’s Release Engineering team. +## Installation + +The Python package can be installed directly from this git repository from either a branch or tag: + +```shell +# recommended: use a version tag (e.g., v0.1.0) +pip install https://github.com/neuralmagic/pytest-nm-releng/archive/v0.1.0.tar.gz + +# alternative: install based on a branch (e.g., main) +pip install https://github.com/neuralmagic/pytest-nm-releng/archive/main.tar.gz +``` + ## Features ### Dynamically-named JUnit report files @@ -25,7 +37,7 @@ export NMRE_JUNIT_BASE=test-results pytest [...] # after either example, a file named something like -# `test-results/1735941024.348248.xml` will be written +# `test-results/1735941024.348248.xml` will be created ``` Optionally, you can define `NMRE_JUNIT_PREFIX` with a value to be prefixed onto the file name. Note that no separator is used so you may want to include one. @@ -36,7 +48,7 @@ export NMRE_JUNIT_PREFIX="report-" pytest [...] # after either example, a file named something like -# `test-results/report-1735941218.338192.xml` will be written +# `test-results/report-1735941218.338192.xml` will be created ``` ### Code coverage diff --git a/tests/__init__.py b/tests/__init__.py index e69de29..c40afb2 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,13 @@ +# Copyright (c) 2025 - present / Neuralmagic, Inc. 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.