Merge pull request #1 from joaovitorsilvestre/simplify_usage

Simplify usage of plugin

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,94 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pytest-slow-first
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+      - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v1.2.3
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          '${{ github.ref_name }}'
+          --repo '${{ github.repository }}'
+          --notes ""
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          '${{ github.ref_name }}' dist/**
+          --repo '${{ github.repository }}'

.gitignore

@@ -5,7 +5,7 @@ __pycache__/
 
 # C extensions
 *.so
-
+.idea/
 # Distribution / packaging
 .Python
 env/

README.md

@@ -39,44 +39,6 @@ In the next time you run it, tests will be sorted by time spend in the last run,
 </br>
 </hr>
 
-Usage
------
-
-You just need to define two functions inside your conftest.py file: `slow_first_save_durations` and `slow_first_load_durations`.
-
-The first one is to save results of current run and the second one is to load the same results in the folowing run. Allowing this plugin to sort execuntion of tests based in these results.
-
-Example of `conftest.py` file:
-```python
-import os, json
-
-
-def slow_first_load_durations():
-    if os.path.exists('/tmp/tests_duration'):
-        with open('/tmp/tests_duration', 'r') as f:
-            return f.read()
-    else:
-        # Durations not found. Run with default order
-        return None
-
-def slow_first_save_durations(durations_data: str):
-    with open('/tmp/tests_duration', 'w') as f:
-        f.write(durations_data)
-```
-
-#### Explanation
-
-1. First, `slow_first_load_durations` will be called before your tests starts running, it will load the durantion of the tests
-of the previous run. 
-
-    * **obs**: if its the first time using this plugin or if you can't load the results, this function must return None.
-
-2. If `slow_first_load_durations` finds data, it returns the content and slow-first plugin will sort your tests, otherwise 
-the test suite will run at default order.
-
-3. If the suit runs with success, `slow_first_save_durations` is going to be called with durations as argument. This function must save the results
-in a way that `slow_first_load_durations` can load in the next run.
-
 ### Running with pytest-slow-first plugin
 Finally, activate the plugin by passing `--slow-first` as paramter of pytest command:
 
@@ -87,6 +49,10 @@ pytest tests --slow-first -n3  # using along side xdist
 </br>
 </hr>
 
+THis plugin will save the duration of each of your tests in a file named `pytest-slow-first.json` in the current directory.
+You can change the location by setting the enviroment variable `SLOW_FIRST_PATH` to the path you want.
+Ex: `export SLOW_FIRST_PATH=/tmp/pytest-slow-first.json pytest --slow-first`
+
 Installation
 ------------