# PokerFileSorter
[](https://pkrfilesorter.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/pkrfilesorter)
[](https://opensource.org/licenses/MIT)
## Description
A package to sort poker files in adapted directories
PokerFileSorter is a simple tool to sort poker files in adapted directories.
## Table of Contents
- [Description](#description)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Documentation](#documentation)
- [License](#license)
## Getting Started
To install the package, use the following command:
```sh
pip install pkrfilesorter
```
If you want to download the source code, you can do so by cloning the repository:
```sh
git clone https://github.com/Manggy94/PokerFileSorter.git
```
## Usage
### Base Examples
Here are some simple examples of using PokerFileSorter:
Sort a poker file to a directory with custom directories:
```python
from pkrfilesorter.file_sorter import FileSorter
sorter = FileSorter("path/to/poker/history/dir", "path/to/sorted/dir")
sorter.copy_files()
```
Setting source directories and destination directories from a .env file:
.env:
```env
SOURCE_DIR="path/to/poker/history/dir"
DESTINATION_DIR="path/to/sorted/dir"
```
Then, in the command line:
```sh
python -m pkrfilesorter.main
```
## Documentation
Read the doc on [ReadTheDocs](https://pkrfilesorter.readthedocs.io/en/latest/)
## License
This project is licensed under the *MIT* license. See the [LICENSE](LICENSE.txt) file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/manggy94/PokerFileSorter",
"name": "pkrfilesorter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Alexandre MANGWA",
"author_email": "alex.mangwa@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/5e/235ef3ebdc6693507cfa847f2bc14ead496e972bd62d97fdb441c77457d6/pkrfilesorter-1.4.1.tar.gz",
"platform": null,
"description": "# PokerFileSorter\n\n\n[](https://pkrfilesorter.readthedocs.io/en/latest/?badge=latest)\n[](https://badge.fury.io/py/pkrfilesorter)\n[](https://opensource.org/licenses/MIT)\n\n## Description\nA package to sort poker files in adapted directories\n\nPokerFileSorter is a simple tool to sort poker files in adapted directories.\n\n## Table of Contents\n\n- [Description](#description)\n- [Getting Started](#getting-started)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [License](#license)\n\n## Getting Started\n\nTo install the package, use the following command:\n\n```sh\npip install pkrfilesorter\n```\n\nIf you want to download the source code, you can do so by cloning the repository:\n\n```sh\ngit clone https://github.com/Manggy94/PokerFileSorter.git\n```\n\n## Usage\n\n### Base Examples\n\nHere are some simple examples of using PokerFileSorter:\n\nSort a poker file to a directory with custom directories:\n\n```python\nfrom pkrfilesorter.file_sorter import FileSorter\n\nsorter = FileSorter(\"path/to/poker/history/dir\", \"path/to/sorted/dir\")\nsorter.copy_files()\n```\n\nSetting source directories and destination directories from a .env file:\n\n.env:\n```env\nSOURCE_DIR=\"path/to/poker/history/dir\"\nDESTINATION_DIR=\"path/to/sorted/dir\"\n```\n\nThen, in the command line:\n```sh\npython -m pkrfilesorter.main\n```\n\n## Documentation\n\nRead the doc on [ReadTheDocs](https://pkrfilesorter.readthedocs.io/en/latest/)\n\n## License\n\nThis project is licensed under the *MIT* license. See the [LICENSE](LICENSE.txt) file for more details.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A package to sort poker files in adapted directories",
"version": "1.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/manggy94//issues",
"Documentation": "https://pkrfilesorter.readthedocs.io/en/latest/",
"Homepage": "https://github.com/manggy94/PokerFileSorter"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a327108619685dca8a7dfcaa7c0bd55c59711ade494fd4acd609fdbf600f4d19",
"md5": "fa68b733f9eb73d35b14b095d8134cd8",
"sha256": "d6df8ee3aaebd997283f27cfbc646179d3b81a937bc621dd1111ac9fd09c91dc"
},
"downloads": -1,
"filename": "pkrfilesorter-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa68b733f9eb73d35b14b095d8134cd8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12196,
"upload_time": "2024-08-20T23:34:46",
"upload_time_iso_8601": "2024-08-20T23:34:46.078121Z",
"url": "https://files.pythonhosted.org/packages/a3/27/108619685dca8a7dfcaa7c0bd55c59711ade494fd4acd609fdbf600f4d19/pkrfilesorter-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d5e235ef3ebdc6693507cfa847f2bc14ead496e972bd62d97fdb441c77457d6",
"md5": "7ccb772070f6572188953ab3d47286a9",
"sha256": "f1796beec691d46f307254061125890b14aa657d3145e11a8afac89085bbfc24"
},
"downloads": -1,
"filename": "pkrfilesorter-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "7ccb772070f6572188953ab3d47286a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11373,
"upload_time": "2024-08-20T23:34:47",
"upload_time_iso_8601": "2024-08-20T23:34:47.466442Z",
"url": "https://files.pythonhosted.org/packages/8d/5e/235ef3ebdc6693507cfa847f2bc14ead496e972bd62d97fdb441c77457d6/pkrfilesorter-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 23:34:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "manggy94",
"github_project": "PokerFileSorter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pkrfilesorter"
}
JSON
