Metadata-Version: 2.1
Name: versioned
Version: 0.6.1
Summary: The version and alias best practice for immutable artifacts and deployment.
Home-page: https://github.com/MacHu-GWU/versioned-project
Download-URL: https://pypi.python.org/pypi/versioned/0.6.1#downloads
Author: Sanhe Hu
Author-email: husanhe@gmail.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@gmail.com
License: MIT
Platform: Windows
Platform: MacOS
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: boto-session-manager <2.0.0,>=1.5.3
Requires-Dist: s3pathlib <3.0.0,>=2.0.1
Requires-Dist: pynamodb <6.0.0,>=5.0.0
Requires-Dist: cached-property >=1.5.2 ; python_version < "3.8"
Provides-Extra: docs
Requires-Dist: sphinx ==5.3.0 ; extra == 'docs'
Requires-Dist: sphinx-jinja ==2.0.2 ; extra == 'docs'
Requires-Dist: sphinx-copybutton ==0.5.1 ; extra == 'docs'
Requires-Dist: rstobj ==1.2.1 ; extra == 'docs'
Requires-Dist: docfly ==1.1.1 ; extra == 'docs'
Requires-Dist: furo ==2023.03.27 ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: moto ; extra == 'tests'
Requires-Dist: rich ; extra == 'tests'


.. image:: https://readthedocs.org/projects/versioned/badge/?version=latest
    :target: https://versioned.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/versioned-project/workflows/CI/badge.svg
    :target: https://github.com/MacHu-GWU/versioned-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/versioned-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/versioned-project

.. image:: https://img.shields.io/pypi/v/versioned.svg
    :target: https://pypi.python.org/pypi/versioned

.. image:: https://img.shields.io/pypi/l/versioned.svg
    :target: https://pypi.python.org/pypi/versioned

.. image:: https://img.shields.io/pypi/pyversions/versioned.svg
    :target: https://pypi.python.org/pypi/versioned

.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/versioned-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/versioned-project

------

.. image:: https://img.shields.io/badge/Link-Document-blue.svg
    :target: https://versioned.readthedocs.io/en/latest/

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://versioned.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/versioned-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/versioned-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/versioned-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/versioned#files


Welcome to ``versioned`` Documentation
==============================================================================
The version and alias best practice for immutable artifacts and deployment.

.. image:: https://github.com/MacHu-GWU/versioned-project/assets/6800411/3c9e9a9b-1875-4660-a3be-82657e364fa2

Tutorial:

- `Quick Start - S3 and Dynamodb Backend <https://github.com/MacHu-GWU/versioned-project/blob/main/examples/s3_and_dynamodb_backend.ipynb>`_
- `Quick Start - S3 only Backend <https://github.com/MacHu-GWU/versioned-project/blob/main/examples/s3_only_backend.ipynb>`_

Learn why Blue / Green, Canary deployment and Rollback made easy with versioning and alias management.

.. image:: https://github.com/MacHu-GWU/versioned-project/assets/6800411/57f7970e-3821-45a0-9deb-64890e04c129

Related Project:

- `aws_glue_artifact <https://github.com/MacHu-GWU/aws_glue_artifact-project>`_ enables the versioned deployment for AWS Glue.
- `airflow_dag_artifact <https://github.com/MacHu-GWU/airflow_dag_artifact-project>`_ enables the versioned deployment for Airflow DAG deployment.


.. _install:

Install
------------------------------------------------------------------------------

``versioned`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install versioned

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade versioned
