.. 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
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/versioned-project",
"name": "versioned",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": "",
"maintainer_email": "husanhe@gmail.com",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e8/84/daa98d7112f34354072752ac7d086517dcd18ad78d3f0ccdcdaa71858b4b/versioned-0.6.1.tar.gz",
"platform": "Windows",
"description": "\n.. image:: https://readthedocs.org/projects/versioned/badge/?version=latest\n :target: https://versioned.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/versioned-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/versioned-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/versioned-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/versioned-project\n\n.. image:: https://img.shields.io/pypi/v/versioned.svg\n :target: https://pypi.python.org/pypi/versioned\n\n.. image:: https://img.shields.io/pypi/l/versioned.svg\n :target: https://pypi.python.org/pypi/versioned\n\n.. image:: https://img.shields.io/pypi/pyversions/versioned.svg\n :target: https://pypi.python.org/pypi/versioned\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/versioned-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/versioned-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://versioned.readthedocs.io/en/latest/\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://versioned.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/versioned-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/versioned-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/versioned-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/versioned#files\n\n\nWelcome to ``versioned`` Documentation\n==============================================================================\nThe version and alias best practice for immutable artifacts and deployment.\n\n.. image:: https://github.com/MacHu-GWU/versioned-project/assets/6800411/3c9e9a9b-1875-4660-a3be-82657e364fa2\n\nTutorial:\n\n- `Quick Start - S3 and Dynamodb Backend <https://github.com/MacHu-GWU/versioned-project/blob/main/examples/s3_and_dynamodb_backend.ipynb>`_\n- `Quick Start - S3 only Backend <https://github.com/MacHu-GWU/versioned-project/blob/main/examples/s3_only_backend.ipynb>`_\n\nLearn why Blue / Green, Canary deployment and Rollback made easy with versioning and alias management.\n\n.. image:: https://github.com/MacHu-GWU/versioned-project/assets/6800411/57f7970e-3821-45a0-9deb-64890e04c129\n\nRelated Project:\n\n- `aws_glue_artifact <https://github.com/MacHu-GWU/aws_glue_artifact-project>`_ enables the versioned deployment for AWS Glue.\n- `airflow_dag_artifact <https://github.com/MacHu-GWU/airflow_dag_artifact-project>`_ enables the versioned deployment for Airflow DAG deployment.\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``versioned`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n $ pip install versioned\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade versioned\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The version and alias best practice for immutable artifacts and deployment.",
"version": "0.6.1",
"project_urls": {
"Download": "https://pypi.python.org/pypi/versioned/0.6.1#downloads",
"Homepage": "https://github.com/MacHu-GWU/versioned-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "580b90e1423f067957d94db12a3071196b0363e9a628e38882d80363ec7117e7",
"md5": "09acc716a85c6de8c26ee34cb1d82d2b",
"sha256": "1f35177edd7435bec3cc7567f05bbdf82fdf3e84feb8ba9c515b484bd124b84c"
},
"downloads": -1,
"filename": "versioned-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09acc716a85c6de8c26ee34cb1d82d2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23330,
"upload_time": "2023-10-22T17:39:16",
"upload_time_iso_8601": "2023-10-22T17:39:16.388067Z",
"url": "https://files.pythonhosted.org/packages/58/0b/90e1423f067957d94db12a3071196b0363e9a628e38882d80363ec7117e7/versioned-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e884daa98d7112f34354072752ac7d086517dcd18ad78d3f0ccdcdaa71858b4b",
"md5": "027d6958265e07ee317fb83836f3b9d4",
"sha256": "7d1287eb3a053f2fe974bff1562721e3f636b05cca51fb6579b34dda80506133"
},
"downloads": -1,
"filename": "versioned-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "027d6958265e07ee317fb83836f3b9d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25591,
"upload_time": "2023-10-22T17:39:17",
"upload_time_iso_8601": "2023-10-22T17:39:17.825166Z",
"url": "https://files.pythonhosted.org/packages/e8/84/daa98d7112f34354072752ac7d086517dcd18ad78d3f0ccdcdaa71858b4b/versioned-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-22 17:39:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "versioned-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "versioned"
}
JSON
