Metadata-Version: 2.1
Name: mocap-maya
Version: 0.2.1
Summary: 
Author: move.ai
Author-email: info@move.ai
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown

# mocap-maya


![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-7F00FF.svg)
![python3.10](https://img.shields.io/badge/python-3.10-blue)
![Coverage](./coverage-badge.svg)
[![Continuous Integration](https://github.com/move-ai/mocap-maya/actions/workflows/continous_integration.yml/badge.svg)](https://github.com/move-ai/mocap-maya/actions/workflows/continous_integration.yml)
[![Release](https://github.com/move-ai/mocap-maya/actions/workflows/release.yml/badge.svg)](https://github.com/move-ai/mocap-maya/actions/workflows/release.yml)

## Description




   
## Installation

1. Install the latest [aws-cli2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)

2. Configure your sso as below:

```bash
aws configure sso
  name = moveai
  start url = https://d-93676e215a.awsapps.com/start#
  region = eu-west-1
  registration scopes =
  profile name: default
aws sso login --profile <profile_name>
```

3. Install [poetry](https://python-poetry.org/docs/#installation):

```bash
pip install poetry
```

Run the following with your profile name:

```bash
export AWS_PIP_PASSWORD=`aws codeartifact get-authorization-token --profile <profile_name> --domain moveai --domain-owner 103680339861 --region eu-west-1 --query authorizationToken --output text`
poetry config http-basic.move aws $AWS_PIP_PASSWORD
poetry install
```

## Pre-commit for contribution

After you perform `poetry install`, please perform the following command. This will allow the pre-commit checks to run each time you commit a new change to git.

```poetry run pre-commit install```


## Usage
    # TODO: Add instructions in https://moveai.atlassian.net/browse/EGT-391

## Tests

From the repo root directory, run:

```bash
poetry run pytest

```


## Version control

This repository follows git flow for version control where two branches are used to maintain development (develop branch) and production (main branch) environments. For more info on gitflow see [this documentation](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)

Only the following branches are allowed to be merged these branches:
1. develop: feature/, bugfix/, main, cruft/, dependabot/
2. main: develop|hotfix/|release/

Please refer to [this](https://www.notion.so/moveai/SPIKE-Infrastructure-36ec9c8c8d114a84bfa0611be6e6f150#752e1d53eb814e2c8820ae3eef48141a) notion doc on the git flow used in this repository.

