| Name | mocap-base JSON |
| Version |
2.1.1
JSON |
| download |
| home_page | None |
| Summary | Base package for mocap pipeline |
| upload_time | 2024-11-12 14:10:37 |
| maintainer | None |
| docs_url | None |
| author | Move.ai |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mocap-base
[](https://github.com/move-ai/mocap-base/actions/workflows/continous_integration.yml)
[](https://github.com/move-ai/mocap-base/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 a trunk-based development in git i.e. all changes are merged to main directly and all branches are created from main. For more info please see [this documentation](https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development).
All PRs are merged to main directly and all branches are created from main. Only these branches are allowed to be merged to the main branch: feature/, hotfix/, bugfix/, dependabot/, cruft/
Note:
- Direct pushes to main are not allowed (this is because of the enforced ruleset on github)
- All changes to be merged to main via a pull request
- A PR can't be merged until both `unittest` and `pre-commit` checks have been passed
Please refer to [this](https://www.notion.so/moveai/SPIKE-Infrastructure-36ec9c8c8d114a84bfa0611be6e6f150#752e1d53eb814e2c8820ae3eef48141a) notion doc on the git flow used in this repository.
## PyPi release
An encrypted version of this package will be released on pypi automatically as part of the release workflow (`release.yml`). If this package doesn't need to be on pypi, please remove this job manually from `.github/workflows/release.yml`
### Troubleshooting
- If the pypi release workflow gets stuck, please make sure that another workflow (in another `mocap-*`) is not running. If another workflow is currently running, then please wait for it to be finished and then try again.
- This is because the WIBU token can only be run on one instance at a time, each subsequent workflow should have a one hour difference between runs - this is a known limitation and would be fixed in a future version of the release workflow in `mocap-template`.
### Encryption setup files
We need the following files for the debianize release action to be able to create an accurate `.deb` release.
1. protect.WibuCpsConf: contains the Wibu configuration to encrpyt the package correctly.
2. CMakeLists.txt: contains a set of directives and instructions describing the project's source files and targets.
3. resources/postinst_template: the post installation template for this project.
Raw data
{
"_id": null,
"home_page": null,
"name": "mocap-base",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Move.ai",
"author_email": "info@move.ai",
"download_url": null,
"platform": null,
"description": "# mocap-base\n\n\n\n\n\n[](https://github.com/move-ai/mocap-base/actions/workflows/continous_integration.yml)\n[](https://github.com/move-ai/mocap-base/actions/workflows/release.yml)\n\n## Description\n\n\n\n \n## Installation\n\n1. Install the latest [aws-cli2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)\n\n2. Configure your sso as below:\n\n```bash\naws configure sso\n name = moveai\n start url = https://d-93676e215a.awsapps.com/start#\n region = eu-west-1\n registration scopes =\n profile name: default\naws sso login --profile <profile_name>\n```\n\n3. Install [poetry](https://python-poetry.org/docs/#installation):\n\n```bash\npip install poetry\n```\n\nRun the following with your profile name:\n\n```bash\nexport AWS_PIP_PASSWORD=`aws codeartifact get-authorization-token --profile <profile_name> --domain moveai --domain-owner 103680339861 --region eu-west-1 --query authorizationToken --output text`\npoetry config http-basic.move aws $AWS_PIP_PASSWORD\npoetry install\n```\n\n## Pre-commit for contribution\n\nAfter 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.\n\n```poetry run pre-commit install```\n\n\n## Usage\n # TODO: Add instructions in https://moveai.atlassian.net/browse/EGT-391\n\n## Tests\n\nFrom the repo root directory, run:\n\n```bash\npoetry run pytest\n\n```\n\n\n## Version control\n\nThis repository follows a trunk-based development in git i.e. all changes are merged to main directly and all branches are created from main. For more info please see [this documentation](https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development).\n\nAll PRs are merged to main directly and all branches are created from main. Only these branches are allowed to be merged to the main branch: feature/, hotfix/, bugfix/, dependabot/, cruft/\n\nNote:\n - Direct pushes to main are not allowed (this is because of the enforced ruleset on github)\n - All changes to be merged to main via a pull request\n - A PR can't be merged until both `unittest` and `pre-commit` checks have been passed\n\nPlease refer to [this](https://www.notion.so/moveai/SPIKE-Infrastructure-36ec9c8c8d114a84bfa0611be6e6f150#752e1d53eb814e2c8820ae3eef48141a) notion doc on the git flow used in this repository.\n\n\n## PyPi release\n\nAn encrypted version of this package will be released on pypi automatically as part of the release workflow (`release.yml`). If this package doesn't need to be on pypi, please remove this job manually from `.github/workflows/release.yml`\n\n### Troubleshooting\n\n- If the pypi release workflow gets stuck, please make sure that another workflow (in another `mocap-*`) is not running. If another workflow is currently running, then please wait for it to be finished and then try again.\n- This is because the WIBU token can only be run on one instance at a time, each subsequent workflow should have a one hour difference between runs - this is a known limitation and would be fixed in a future version of the release workflow in `mocap-template`.\n\n### Encryption setup files\n\nWe need the following files for the debianize release action to be able to create an accurate `.deb` release.\n\n1. protect.WibuCpsConf: contains the Wibu configuration to encrpyt the package correctly.\n2. CMakeLists.txt: contains a set of directives and instructions describing the project's source files and targets.\n3. resources/postinst_template: the post installation template for this project.\n",
"bugtrack_url": null,
"license": null,
"summary": "Base package for mocap pipeline",
"version": "2.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b11621d2b28e45f19223207c27bdebb2023478d2d51f40b1b24858ef2cbceb14",
"md5": "ed39eefaa5fc18aeb2dd27c0a98907b5",
"sha256": "a15985fdd0763d0c67fca1e5370a0ecc164aae57580488670bdcff13d6c9651f"
},
"downloads": -1,
"filename": "mocap_base-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed39eefaa5fc18aeb2dd27c0a98907b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 1947186,
"upload_time": "2024-11-12T14:10:37",
"upload_time_iso_8601": "2024-11-12T14:10:37.500191Z",
"url": "https://files.pythonhosted.org/packages/b1/16/21d2b28e45f19223207c27bdebb2023478d2d51f40b1b24858ef2cbceb14/mocap_base-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 14:10:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mocap-base"
}
