accsyn-python-api 3.1.0__tar.gz → 3.2.1__tar.gz

{accsyn_python_api-3.1.0 → accsyn_python_api-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: accsyn-python-api
-Version: 3.1.0
+Version: 3.2.1
 Summary: A Python API for accsyn programmable fast and secure data delivery software
 Home-page: https://accsyn.com
 License: Apache-2.0
@@ -93,8 +93,55 @@ poetry run black .
 
 ```
 
-Building and Publishing:
------------------------
+Testing:
+--------
+
+The test suite requires role-specific credential files to test different user permissions,
+Tests will be skipped if the required .env files are not present.
+The tests also requires active accsyn clients running on behalf of the users, to be able to fully
+test file transfers and compute. This requires all tests to run interactively, to be able to action
+prompts that may appear during execution.
+
+**Prepare test credentials:**
+
+Create three `.env` files in the project root directory, one for each role:
+
+1. `.env.admin` - Admin role credentials
+2. `.env.employee` - Employee role credentials
+3. `.env.standard` - Standard (restricted end user) role credentials
+
+Each `.env` file should contain:
+
+```bash
+ACCSYN_WORKSPACE=your_workspace
+ACCSYN_API_USER=user@example.com
+ACCSYN_API_KEY=your_api_key
+```
+
+**Run tests:**
+
+```bash
+# Run all tests
+poetry run pytest -x -s
+
+# Run with coverage report
+poetry run pytest -x -s --cov=accsyn_api --cov-report=term-missing
+
+# Run a specific test file
+poetry run pytest -x -s tests/test_find_entitytypes.py
+
+# Some tests have dependencies in form of running clients, run interactively:
+poetry run pytest -x -s tests/test_find_entitytypes.py
+
+```
+
+**Categories:** Use `@pytest.mark.base` for tests that create entities; use `@pytest.mark.extended` and `@pytest.mark.order(2)` (or higher) for tests that depend on those entities. Run `pytest -m "base or extended"` to run both in order in one session.
+
+**Note:** Tests that require a specific role will be skipped if the corresponding `.env` file is missing.
+
+
+Building and publishing to PyPi:
+--------------------------------
 
 ```bash
 # Build the package
@@ -108,6 +155,8 @@ poetry config repositories.testpypi https://test.pypi.org/legacy/
 poetry publish -r testpypi
 ```
 
+Poetry can use saved credentials (`poetry config pypi-token.pypi <token>`) or username/password flags such as `poetry publish --username <user> --password <pass>`.
+
 accsyn(r) - secure high speed file delivery and workflow sync
 https://accsyn.com 
 https://support.accsyn.com

accsyn_python_api-3.2.1/README.md

@@ -0,0 +1,133 @@
+# accsyn-python-api
+Official accsyn fast and secure file delivery Python API
+
+Python API support can be found [here](https://support.accsyn.com/workflows/python-api).
+
+
+Changelog:
+----------
+
+See doc/release_notes.rst
+
+
+Documentation:
+--------------
+
+[https://accsyn-python-api.readthedocs.io/en/latest](https://accsyn-python-api.readthedocs.io/en/latest)
+
+
+Development Setup:
+------------------
+
+This project uses Poetry for dependency management. To get started:
+
+```bash
+# Install Poetry (if not already installed)
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Install dependencies
+poetry install
+
+# Install with documentation dependencies
+poetry install --with docs
+
+# Activate the virtual environment
+poetry shell
+```
+
+Building Documentation:
+----------------------
+
+To build the documentation locally:
+
+```bash
+# Install with docs dependencies
+poetry install --with docs
+
+# Build docs
+cd doc
+poetry run sphinx-build -T -E -b html -d _build/doctrees -D language=en . ../dist/doc
+```
+
+Or use the shorter command:
+```bash
+poetry run sphinx-build -b html doc dist/doc
+```
+
+Development Tools:
+-----------------
+
+```bash
+# Format code
+poetry run black .
+
+```
+
+Testing:
+--------
+
+The test suite requires role-specific credential files to test different user permissions,
+Tests will be skipped if the required .env files are not present.
+The tests also requires active accsyn clients running on behalf of the users, to be able to fully
+test file transfers and compute. This requires all tests to run interactively, to be able to action
+prompts that may appear during execution.
+
+**Prepare test credentials:**
+
+Create three `.env` files in the project root directory, one for each role:
+
+1. `.env.admin` - Admin role credentials
+2. `.env.employee` - Employee role credentials
+3. `.env.standard` - Standard (restricted end user) role credentials
+
+Each `.env` file should contain:
+
+```bash
+ACCSYN_WORKSPACE=your_workspace
+ACCSYN_API_USER=user@example.com
+ACCSYN_API_KEY=your_api_key
+```
+
+**Run tests:**
+
+```bash
+# Run all tests
+poetry run pytest -x -s
+
+# Run with coverage report
+poetry run pytest -x -s --cov=accsyn_api --cov-report=term-missing
+
+# Run a specific test file
+poetry run pytest -x -s tests/test_find_entitytypes.py
+
+# Some tests have dependencies in form of running clients, run interactively:
+poetry run pytest -x -s tests/test_find_entitytypes.py
+
+```
+
+**Categories:** Use `@pytest.mark.base` for tests that create entities; use `@pytest.mark.extended` and `@pytest.mark.order(2)` (or higher) for tests that depend on those entities. Run `pytest -m "base or extended"` to run both in order in one session.
+
+**Note:** Tests that require a specific role will be skipped if the corresponding `.env` file is missing.
+
+
+Building and publishing to PyPi:
+--------------------------------
+
+```bash
+# Build the package
+poetry build
+
+# Publish to PyPI (requires authentication)
+poetry publish
+
+# Or publish to test PyPI first
+poetry config repositories.testpypi https://test.pypi.org/legacy/
+poetry publish -r testpypi
+```
+
+Poetry can use saved credentials (`poetry config pypi-token.pypi <token>`) or username/password flags such as `poetry publish --username <user> --password <pass>`.
+
+accsyn(r) - secure high speed file delivery and workflow sync
+https://accsyn.com 
+https://support.accsyn.com
+

{accsyn_python_api-3.1.0 → accsyn_python_api-3.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "accsyn-python-api"
-version = "3.1.0"
+version = "3.2.1"
 description = "A Python API for accsyn programmable fast and secure data delivery software"
 authors = ["Henrik Norin <support@accsyn.com>"]
 license = "Apache-2.0"
@@ -29,6 +29,9 @@ classifiers = [
 ]
 packages = [{include = "accsyn_api", from = "source"}]
 
+[tool.poetry.scripts]
+test = "accsyn_api._devtools:test"
+
 [tool.poetry.dependencies]
 python = "^3.8"
 requests = "^2.25.0"
@@ -43,6 +46,7 @@ flake8 = "^5.0.0"
 mypy = "^1.0.0"
 pytest = "^7.0.0"
 pytest-cov = "^4.0.0"
+pytest-order = "^1.0.0"
 
 [tool.poetry.group.docs]
 optional = true
@@ -76,4 +80,8 @@ disallow_untyped_defs = true
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = ["test_*.py", "*_test.py"]
-addopts = "--cov=accsyn_api --cov-report=term-missing"
+addopts = "--cov=accsyn_api --cov-report=term-missing -x"
+markers = [
+    "base: Phase 1 tests that create entities (run first).",
+    "extended: Phase 2 tests that depend on entities created by base (run after base).",
+]

accsyn_python_api-3.2.1/source/accsyn_api/_devtools.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+from typing import Optional, Sequence
+
+
+def run_pytest(argv: Optional[Sequence[str]] = None) -> int:
+    """
+    Run pytest from the repository root, regardless of current working directory.
+
+    This makes `poetry run test` work even if invoked from e.g. `doc/`.
+    """
+    repo_root = Path(__file__).resolve().parents[2]
+    os.chdir(repo_root)
+
+    args = list(sys.argv[1:] if argv is None else argv)
+    # Ensure we always pick up the project's pytest settings.
+    if "-c" not in args and "--config-file" not in args:
+        args = ["-c", str(repo_root / "pyproject.toml"), *args]
+
+    import pytest
+
+    return pytest.main(args)
+
+
+def test() -> None:
+    """Poetry script entrypoint: `poetry run test [pytest-args...]`."""
+    raise SystemExit(run_pytest())

{accsyn_python_api-3.1.0 → accsyn_python_api-3.2.1}/source/accsyn_api/_version.py

@@ -1,4 +1,4 @@
 # :coding: utf-8
 # :copyright: Copyright (c) 2015-2023 accsyn/HDR AB
 
-__version__ = "3.1.0-1"
+__version__ = "3.2.1-0"