Metadata-Version: 2.1
Name: versioned
Version: 0.2.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.2.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
Provides-Extra: tests
Provides-Extra: docs
License-File: LICENSE.txt
License-File: AUTHORS.rst


.. 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.

Tutorial:

- `Quick Start <https://github.com/MacHu-GWU/versioned-project/blob/main/examples/Quick-Start.ipynb>`_


.. _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
