Metadata-Version: 2.1
Name: metaworkspace
Version: 0.3.4
Summary: Python-React application for visualization of urban data
Home-page: https://github.com/MetacitySuite/Metacity-Workspace
Author: Metacity
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# Metacity Workspace

[![Build Status](https://github.com/MetacitySuite/Metacity-Workspace/workflows/Metacity%20Workspace%20CI/badge.svg)](https://github.com/MetacitySuite/Metacity-Workspace/actions?query=workflow%3A%22Metacity+Workspace+CI%22)
[![Pypi version](https://badge.fury.io/py/metaworkspace.svg)](https://pypi.org/project/metaworkspace/)

Metacity Workspace is a Python package, which is also the main Metacity application. 

See running live:
http://metacity.cc

## Installation

Install with:
```
pip install metaworkspace
```
For easy installation, follow the instructions described [here](https://github.com/MetacitySuite/Metacity-Guide).

## Branches
| Branch | Description |
| ------ | ----------- |
| main   | protected, merged PRs auto tested and deployed to PyPI and to live server if tag present |
| dev    | merged PRs auto tested and version bumped if tag present |


## PR Merge Commit message conventions
Use any of the following tags in the merge commit message title to indicate the type of PR:

| In commit message | Descrition | Branches |
| ---------------------- | ----------- | ------- |
| `action::bump` | flag to run bump pipeline | dev |
| `action::package` | flag to run deploy package to PyPI | main |
| `action::deploy` | flag to run deploy to metacity.cc server | main |

Dev branch actions (together with `action::bump`):

| In commit message | Descrition | Branches |
| ---------------------- | ----------- | ------- |
| `version::patch` | bump version after patch/bug fix/minor change | dev |
| `version::minor` | bump version after new feature/minor change | dev |
| `version::major` | bump version after major change/breaking change | dev |

If no tag is used, no action runs after the PR is merged. If no version tag is used, the version is bumped as patch.

