# Introdction
This package provides a utility for analyzing a golf swing. The input data is represented as a json file
generated by [GolfTracker](https://pypi.org/project/golftracker/).
The json file structure is represented by a data class "GolfData". A factory method is used to create it from the json filename.
The structure of the *GolfData* class is shown below.
## Installation
Install the package in your virtual env.
```
pip install golftrainer
```
## Demo
For this purpose we will use **data/demo.json** as an example. This file is same as "00001.json" from the below google drive.
### Setup Jupyter Notebook
To make the notebook run under my virtual env (say 'venv'), follow the following steps.
```
pip install jupyter
```
Or for existing install create a new kernel.
```
ipython kernel install --user --name=venv
```
```
cd notebooks/demo
jupyter notebook demo1.ipynb
```
Once we have the notebook the following commands we can use the GolfData object to access the parameters.
## Generated Data
Various sample golf swing videos shot down the line on a right handed golf player with the corresponding json file are stored in this [GoogleDrive](https://drive.google.com/drive/folders/1TDUnGjP1wh1gZeN1EZdJOO4AeYuMLnkO?usp=sharing). Each video file (either a mp4 or mov) has 2 output files. The ".pkl" is the pickle database and ".json" is the file that we will use for this package to measure the various metrics associated with the swing.
Raw data
{
"_id": null,
"home_page": "https://github.com/sanjeevs/golftrainer",
"name": "golftrainer",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Sanjeev Singh",
"author_email": "snjvsingh123@gmail.com",
"download_url": "",
"platform": null,
"description": "# Introdction\r\nThis package provides a utility for analyzing a golf swing. The input data is represented as a json file\r\ngenerated by [GolfTracker](https://pypi.org/project/golftracker/). \r\n\r\nThe json file structure is represented by a data class \"GolfData\". A factory method is used to create it from the json filename.\r\n\r\nThe structure of the *GolfData* class is shown below.\r\n\r\n\r\n\r\n## Installation\r\nInstall the package in your virtual env.\r\n\r\n```\r\npip install golftrainer\r\n```\r\n\r\n## Demo\r\nFor this purpose we will use **data/demo.json** as an example. This file is same as \"00001.json\" from the below google drive.\r\n\r\n### Setup Jupyter Notebook\r\nTo make the notebook run under my virtual env (say 'venv'), follow the following steps.\r\n\r\n```\r\n\r\npip install jupyter\r\n\r\n```\r\n\r\nOr for existing install create a new kernel.\r\n\r\n```\r\nipython kernel install --user --name=venv\r\n\r\n```\r\n\r\n```\r\ncd notebooks/demo\r\n\r\njupyter notebook demo1.ipynb \r\n```\r\n\r\nOnce we have the notebook the following commands we can use the GolfData object to access the parameters.\r\n\r\n\r\n## Generated Data\r\nVarious sample golf swing videos shot down the line on a right handed golf player with the corresponding json file are stored in this [GoogleDrive](https://drive.google.com/drive/folders/1TDUnGjP1wh1gZeN1EZdJOO4AeYuMLnkO?usp=sharing). Each video file (either a mp4 or mov) has 2 output files. The \".pkl\" is the pickle database and \".json\" is the file that we will use for this package to measure the various metrics associated with the swing.\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Analyze a golf swing looking at critical points.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/sanjeevs/golftrainer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71912e03bd74b5dd5b4947fae9091862aea878a9e7f043b449e74adcd3e664c2",
"md5": "7961e48b6f2d25dbefd4edb5c1981251",
"sha256": "c126592e6689defeac41cb0a2b5d9c2c924a260ed61c1b763d9da9d8abf76969"
},
"downloads": -1,
"filename": "golftrainer-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7961e48b6f2d25dbefd4edb5c1981251",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5247,
"upload_time": "2024-01-06T18:13:29",
"upload_time_iso_8601": "2024-01-06T18:13:29.819486Z",
"url": "https://files.pythonhosted.org/packages/71/91/2e03bd74b5dd5b4947fae9091862aea878a9e7f043b449e74adcd3e664c2/golftrainer-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-06 18:13:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sanjeevs",
"github_project": "golftrainer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "golftrainer"
}
JSON
