Metadata-Version: 2.4
Name: script-forge-project-api
Version: 26.0.0
Summary: Script Forge Project API - core storage tuples, context and migration layer
Author: Script Forge HQ Pty Ltd
License: MIT
Project-URL: Homepage, https://github.com/RunScriptForge/script-forge-project-api
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
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: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: twisted
Requires-Dist: pygit2==1.18.*
Requires-Dist: vortexpy>=4.0.0
Requires-Dist: pytz
Requires-Dist: pathvalidate
Requires-Dist: py7zr
Requires-Dist: markdown
Requires-Dist: alembic
Requires-Dist: mako
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: pytmpdir; extra == "docs"
Dynamic: license-file

========================
Script Forge Project API
========================

Core storage, tuple, context and migration layer for the Script Forge platform.

This package provides the foundational data model (Tuples), object storage context,
relation handling, Alembic migrations, and remote access utilities used throughout
Script Forge.

Features
--------

- Strongly typed Tuple definitions for plans, jobs, steps, files, parameters, etc.
- ``ObjectStorageContext`` and storage abstractions
- Alembic-based schema migrations
- Git context helpers and key utilities
- Remote execution and serialization support

Installation
------------

.. code-block:: bash

   pip install script-forge-project-api

Development
-----------

The package uses a custom ``setup.py`` that also cleans egg-info on each run.

To build a distribution:

.. code-block:: bash

   python setup.py sdist bdist_wheel

To publish (maintainers):

.. code-block:: bash

   ./publish.sh

License
-------

This project is released under the **MIT License**.

Copyright (c) 2026 Script Forge HQ Pty Ltd

See the `LICENSE <LICENSE>` file for the full text.

Related Projects
----------------

- `script-forge-legacy <https://github.com/RunScriptForge/script-forge-legacy>`_ — Main Script Forge application
- `script-forge-packaging <https://github.com/RunScriptForge/script-forge-packaging>`_ — Enterprise Linux packaging
- `script-forge-doc <https://github.com/RunScriptForge/script-forge-doc>`_ — Official documentation

For more information visit https://scriptforge.io/
