# README: vm-pkg-tools
## Overview
`vm-pkg-tools` is a Python package designed to facilitate parsing scout files for volleyball analytics. This document outlines the process to build, test, and deploy the package, as well as instructions to use it effectively.
---
## Directory Structure
Ensure the project structure aligns with the following:
```bash
project_root/
├── data/
│ └── scouts/
│ └── &1003.dvw
├── src/
│ ├── vm_pkg_tools/
│ │ ├── core/
│ │ │ ├── main.py
│ │ │ └── orchestrator.py
│ │ ├── parsers/
│ │ ├── utils/
│ │ └── validators/
├── tests/
├── README.md
├── requirements.txt
├── setup.py
└── dist/
```
---
## Requirements
### Runtime Dependencies
The following dependencies are required for the package to run:
- `click>=8.1,<9.0`
- `pydantic>=2.0,<3.0`
- `sqlalchemy>=2.0,<3.0`
- `PyYAML>=6.0,<7.0`
- `unidecode>=1.3,<2.0`
- `chardet>=5.0,<6.0`
- `colorlog>=6.0,<7.0`
### Development and Testing Dependencies
For local testing and development, include:
- `black>=24.10`
- `flake8>=7.1`
- `isort>=5.13`
- `pylint>=3.3`
- `pytest>=8.3.4`
- `attrs>=24.3`
- `twine`
- `setuptools`
---
## Installation
### Install Locally for Testing
1. Build the package:
```bash
python setup.py sdist bdist_wheel
```
2. Install the package in a virtual environment:
```bash
python -m venv test_env
source test_env/bin/activate
pip install dist/vm_pkg_tools-<version>-py3-none-any.whl
```
3. Verify installation:
```bash
vmtools-cli --help
```
---
## Usage
### Parsing a Scout File
Ensure that the `data/scouts/` directory exists and contains the required scout file:
```bash
vmtools-cli parse data/scouts/&1003.dvw
```
---
## Testing the Package
1. Create a fresh virtual environment:
```bash
python -m venv test_env
source test_env/bin/activate
```
2. Install the built package:
```bash
pip install dist/vm_pkg_tools-<version>-py3-none-any.whl
```
3. Run commands to verify functionality:
```bash
vmtools-cli parse data/scouts/&1003.dvw
```
4. Run tests:
```bash
pytest tests/
```
---
## Deployment
1. Remove old build artifacts:
```bash
rm -rf build/ dist/ *.egg-info
```
2. Build the package:
```bash
python setup.py sdist bdist_wheel
```
3. Upload to PyPI:
```bash
twine upload dist/*
```
4. Verify the package on PyPI:
[PyPI Project Page](https://pypi.org/project/vm-pkg-tools/)
---
## Versioning
### Tagging a Release
After testing and deploying, tag the release for version tracking:
```bash
git tag v<version>
git push origin v<version>
```
---
## Common Issues
### Missing Dependencies
If a dependency is missing during testing, add it to `install_requires` in `setup.py` and rebuild the package.
### File Not Found Errors
Ensure the required files are not ignored by `.gitignore` and exist in the expected directories.
### Import Errors
Verify all imports use the correct relative paths and update `PYTHONPATH` if necessary.
---
## License
This project is licensed under a **Custom Proprietary License**.
The use of this software is strictly prohibited for any of the following purposes without prior written consent from the author:
- Commercial use
- Redistribution or sublicensing
- Modification or derivation for other applications or platforms
By accessing this software, you agree to adhere to the terms outlined in the [LICENSE](LICENSE) file. For further details, see the [COPYRIGHT](COPYRIGHT) file.
For licensing inquiries, please contact the author:
**Reza Barzegar Gashti**
[rezabarzegargashti@gmail.com](mailto:rezabarzegargashti@gmail.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/volleymateteam/scout_parser_py",
"name": "vm-pkg-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "volleyball, parser, dvw, scout files",
"author": "Reza Barzegar Gashti",
"author_email": "rezabarzegargashti@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/d2/3fc0eb8c11e8acdab374256e712be20ef5677ae0e0ca09353d84ff334d92/vm_pkg_tools-1.0.22.tar.gz",
"platform": null,
"description": "# README: vm-pkg-tools\n\n## Overview\n\n`vm-pkg-tools` is a Python package designed to facilitate parsing scout files for volleyball analytics. This document outlines the process to build, test, and deploy the package, as well as instructions to use it effectively.\n\n---\n\n## Directory Structure\n\nEnsure the project structure aligns with the following:\n\n```bash\nproject_root/\n\u251c\u2500\u2500 data/\n\u2502 \u2514\u2500\u2500 scouts/\n\u2502 \u2514\u2500\u2500 &1003.dvw\n\u251c\u2500\u2500 src/\n\u2502 \u251c\u2500\u2500 vm_pkg_tools/\n\u2502 \u2502 \u251c\u2500\u2500 core/\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 main.py\n\u2502 \u2502 \u2502 \u2514\u2500\u2500 orchestrator.py\n\u2502 \u2502 \u251c\u2500\u2500 parsers/\n\u2502 \u2502 \u251c\u2500\u2500 utils/\n\u2502 \u2502 \u2514\u2500\u2500 validators/\n\u251c\u2500\u2500 tests/\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 requirements.txt\n\u251c\u2500\u2500 setup.py\n\u2514\u2500\u2500 dist/\n```\n\n---\n\n## Requirements\n\n### Runtime Dependencies\n\nThe following dependencies are required for the package to run:\n\n- `click>=8.1,<9.0`\n- `pydantic>=2.0,<3.0`\n- `sqlalchemy>=2.0,<3.0`\n- `PyYAML>=6.0,<7.0`\n- `unidecode>=1.3,<2.0`\n- `chardet>=5.0,<6.0`\n- `colorlog>=6.0,<7.0`\n\n### Development and Testing Dependencies\n\nFor local testing and development, include:\n\n- `black>=24.10`\n- `flake8>=7.1`\n- `isort>=5.13`\n- `pylint>=3.3`\n- `pytest>=8.3.4`\n- `attrs>=24.3`\n- `twine`\n- `setuptools`\n\n---\n\n## Installation\n\n### Install Locally for Testing\n\n1. Build the package:\n\n ```bash\n python setup.py sdist bdist_wheel\n ```\n\n2. Install the package in a virtual environment:\n\n ```bash\n python -m venv test_env\n source test_env/bin/activate\n pip install dist/vm_pkg_tools-<version>-py3-none-any.whl\n ```\n\n3. Verify installation:\n\n ```bash\n vmtools-cli --help\n ```\n\n---\n\n## Usage\n\n### Parsing a Scout File\n\nEnsure that the `data/scouts/` directory exists and contains the required scout file:\n\n```bash\nvmtools-cli parse data/scouts/&1003.dvw\n```\n\n---\n\n## Testing the Package\n\n1. Create a fresh virtual environment:\n\n ```bash\n python -m venv test_env\n source test_env/bin/activate\n ```\n\n2. Install the built package:\n\n ```bash\n pip install dist/vm_pkg_tools-<version>-py3-none-any.whl\n ```\n\n3. Run commands to verify functionality:\n\n ```bash\n vmtools-cli parse data/scouts/&1003.dvw\n ```\n\n4. Run tests:\n\n ```bash\n pytest tests/\n ```\n\n---\n\n## Deployment\n\n1. Remove old build artifacts:\n\n ```bash\n rm -rf build/ dist/ *.egg-info\n ```\n\n2. Build the package:\n\n ```bash\n python setup.py sdist bdist_wheel\n ```\n\n3. Upload to PyPI:\n\n ```bash\n twine upload dist/*\n ```\n\n4. Verify the package on PyPI:\n [PyPI Project Page](https://pypi.org/project/vm-pkg-tools/)\n\n---\n\n## Versioning\n\n### Tagging a Release\n\nAfter testing and deploying, tag the release for version tracking:\n\n```bash\ngit tag v<version>\ngit push origin v<version>\n```\n\n---\n\n## Common Issues\n\n### Missing Dependencies\n\nIf a dependency is missing during testing, add it to `install_requires` in `setup.py` and rebuild the package.\n\n### File Not Found Errors\n\nEnsure the required files are not ignored by `.gitignore` and exist in the expected directories.\n\n### Import Errors\n\nVerify all imports use the correct relative paths and update `PYTHONPATH` if necessary.\n\n---\n\n## License\n\nThis project is licensed under a **Custom Proprietary License**.\n\nThe use of this software is strictly prohibited for any of the following purposes without prior written consent from the author:\n\n- Commercial use\n- Redistribution or sublicensing\n- Modification or derivation for other applications or platforms\n\nBy accessing this software, you agree to adhere to the terms outlined in the [LICENSE](LICENSE) file. For further details, see the [COPYRIGHT](COPYRIGHT) file.\n\nFor licensing inquiries, please contact the author: \n**Reza Barzegar Gashti** \n[rezabarzegargashti@gmail.com](mailto:rezabarzegargashti@gmail.com)\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "A private package for scout file parsing.",
"version": "1.0.22",
"project_urls": {
"Homepage": "https://github.com/volleymateteam/scout_parser_py"
},
"split_keywords": [
"volleyball",
" parser",
" dvw",
" scout files"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8f0850529b41517a20090db5015fa5034116df9edfd954bf53debf22194eb2eb",
"md5": "5b509635e438dc149dbf1576510a3806",
"sha256": "b57ff0277a9dd39d3a652632beb0f71352b429e46147b87caa1ce873fb038441"
},
"downloads": -1,
"filename": "vm_pkg_tools-1.0.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b509635e438dc149dbf1576510a3806",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 23496,
"upload_time": "2025-02-07T18:04:28",
"upload_time_iso_8601": "2025-02-07T18:04:28.247282Z",
"url": "https://files.pythonhosted.org/packages/8f/08/50529b41517a20090db5015fa5034116df9edfd954bf53debf22194eb2eb/vm_pkg_tools-1.0.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "42d23fc0eb8c11e8acdab374256e712be20ef5677ae0e0ca09353d84ff334d92",
"md5": "b5460554e70c8765576c82cd4e697efa",
"sha256": "1e5d453de06cfae781c14b99dd7cd6ac8b13d50f4525fcbb5bbce9d01c3b9529"
},
"downloads": -1,
"filename": "vm_pkg_tools-1.0.22.tar.gz",
"has_sig": false,
"md5_digest": "b5460554e70c8765576c82cd4e697efa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 17840,
"upload_time": "2025-02-07T18:04:30",
"upload_time_iso_8601": "2025-02-07T18:04:30.922771Z",
"url": "https://files.pythonhosted.org/packages/42/d2/3fc0eb8c11e8acdab374256e712be20ef5677ae0e0ca09353d84ff334d92/vm_pkg_tools-1.0.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 18:04:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "volleymateteam",
"github_project": "scout_parser_py",
"github_not_found": true,
"lcname": "vm-pkg-tools"
}
JSON
