accsyn-python-api 3.0.3__tar.gz → 3.2.0__tar.gz

accsyn_python_api-3.2.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.1
+Name: accsyn-python-api
+Version: 3.2.0
+Summary: A Python API for accsyn programmable fast and secure data delivery software
+Home-page: https://accsyn.com
+License: Apache-2.0
+Keywords: accsyn,api,file-transfer,delivery
+Author: Henrik Norin
+Author-email: support@accsyn.com
+Requires-Python: >=3.8,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: File Transfer Protocol (FTP)
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: requests (>=2.25.0,<3.0.0)
+Project-URL: Bug Tracker, https://github.com/accsyn/accsyn-python-api/issues
+Project-URL: Documentation, https://accsyn-python-api.readthedocs.io
+Project-URL: Repository, https://github.com/accsyn/accsyn-python-api.git
+Project-URL: Support, https://support.accsyn.com
+Description-Content-Type: text/markdown
+
+# 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.2.0/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.2.0/pyproject.toml

@@ -0,0 +1,87 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "accsyn-python-api"
+version = "3.2.0"
+description = "A Python API for accsyn programmable fast and secure data delivery software"
+authors = ["Henrik Norin <support@accsyn.com>"]
+license = "Apache-2.0"
+readme = "README.md"
+homepage = "https://accsyn.com"
+repository = "https://github.com/accsyn/accsyn-python-api.git"
+documentation = "https://accsyn-python-api.readthedocs.io"
+keywords = ["accsyn", "api", "file-transfer", "delivery"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: File Transfer Protocol (FTP)",
+]
+packages = [{include = "accsyn_api", from = "source"}]
+
+[tool.poetry.scripts]
+test = "accsyn_api._devtools:test"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+requests = "^2.25.0"
+
+[tool.poetry.group.dev]
+optional = true
+
+[tool.poetry.group.dev.dependencies]
+black = "^23.0.0"
+isort = "^5.12.0"
+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
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^1.2.2"
+sphinx-rtd-theme = "^0.1.6,<1"
+jinja2 = "<3.1"
+lowdown = "^0.1.0,<2"
+tomli = {version = "^2.0.0", python = "<3.11"}
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/accsyn/accsyn-python-api/issues"
+"Support" = "https://support.accsyn.com"
+
+[tool.black]
+line-length = 119
+skip-string-normalization = true
+target-version = ['py38']
+
+[tool.isort]
+profile = "black"
+line_length = 119
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+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.0/source/accsyn_api/_devtools.py

@@ -0,0 +1,31 @@
+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.0.3 → accsyn_python_api-3.2.0}/source/accsyn_api/_version.py

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