| Name | runefumbler JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | Don't be fumblin' no trades now |
| upload_time | 2024-09-15 20:52:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Runefumbler
The execution engine for interacting with runescape client.
## Project Development Setup
This project uses a Windows batch script, `dev.bat`, to simplify the management of the Python development environment. The script handles virtual environment creation, dependency management, formatting, and testing.
### Prerequisites
Ensure the following are installed on your machine:
- [Python 3.11](https://www.python.org/downloads/release/python-3110/)
- [Poetry](https://python-poetry.org/docs/#installation) (automatically installed if missing)
### Usage
#### 1. Setting up the Development Environment
To create a virtual environment and install the necessary dependencies, including development packages, run:
```bash
dev.bat create-dev
```
This will:
- Create a virtual environment in the `.venv` directory (if not already created).
- Install `poetry` inside the virtual environment (if not available).
- Install all project dependencies as defined in `pyproject.toml`, including the `dev` dependencies.
- run `.venv\Scripts\activate` to activate your env
#### 2. Formatting Code
To automatically format your Python code using `black` and `isort`, run:
```bash
dev.bat format
```
This command applies both formatters across the project codebase.
#### 3. Checking Code Formatting
To check if your code adheres to the project's formatting standards without applying changes, run:
```bash
dev.bat format-check
```
This will verify that the code is formatted according to `black` and `isort` rules.
#### 4. Checking Dependencies
To check for any potential issues in your project dependencies, such as unused or incorrect packages, run:
```bash
dev.bat dep-check
```
#### 5. Updating the Development Environment
To update all the project dependencies to their latest compatible versions, run:
```bash
dev.bat update-dev
```
#### 6. Running Tests
To run the test suite with `pytest`, along with coverage reports, run:
```bash
dev.bat test
```
This command generates both terminal and HTML coverage reports, with coverage information for the `./runespreader` directory.
#### Available Commands
| Command | Description |
|-----------------|--------------------------------------------------------------------------|
| `create-dev` | Set up the virtual environment and install dependencies |
| `format` | Format the code using `black` and `isort` |
| `format-check` | Check the code formatting without making changes |
| `dep-check` | Check for dependency issues using `deptry` |
| `update-dev` | Update all project dependencies to their latest compatible versions |
| `test` | Run the test suite with `pytest` and generate coverage reports |
Raw data
{
"_id": null,
"home_page": null,
"name": "runefumbler",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "None",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b6/8c/6cae55b9531643b95d596797f1a5e86e64fc524d3398c66f70bb6813e0ca/runefumbler-0.1.5.tar.gz",
"platform": null,
"description": "# Runefumbler\n\nThe execution engine for interacting with runescape client.\n\n\n## Project Development Setup\n\nThis project uses a Windows batch script, `dev.bat`, to simplify the management of the Python development environment. The script handles virtual environment creation, dependency management, formatting, and testing.\n\n\n### Prerequisites\n\nEnsure the following are installed on your machine:\n\n- [Python 3.11](https://www.python.org/downloads/release/python-3110/)\n- [Poetry](https://python-poetry.org/docs/#installation) (automatically installed if missing)\n\n### Usage\n\n#### 1. Setting up the Development Environment\n\nTo create a virtual environment and install the necessary dependencies, including development packages, run:\n\n```bash\ndev.bat create-dev\n```\n\nThis will:\n- Create a virtual environment in the `.venv` directory (if not already created).\n- Install `poetry` inside the virtual environment (if not available).\n- Install all project dependencies as defined in `pyproject.toml`, including the `dev` dependencies.\n- run `.venv\\Scripts\\activate` to activate your env \n\n\n#### 2. Formatting Code\n\nTo automatically format your Python code using `black` and `isort`, run:\n\n```bash\ndev.bat format\n```\n\nThis command applies both formatters across the project codebase.\n\n#### 3. Checking Code Formatting\n\nTo check if your code adheres to the project's formatting standards without applying changes, run:\n\n```bash\ndev.bat format-check\n```\n\nThis will verify that the code is formatted according to `black` and `isort` rules.\n\n#### 4. Checking Dependencies\n\nTo check for any potential issues in your project dependencies, such as unused or incorrect packages, run:\n\n```bash\ndev.bat dep-check\n```\n\n#### 5. Updating the Development Environment\n\nTo update all the project dependencies to their latest compatible versions, run:\n\n```bash\ndev.bat update-dev\n```\n\n#### 6. Running Tests\n\nTo run the test suite with `pytest`, along with coverage reports, run:\n\n```bash\ndev.bat test\n```\n\nThis command generates both terminal and HTML coverage reports, with coverage information for the `./runespreader` directory.\n\n#### Available Commands\n\n| Command | Description |\n|-----------------|--------------------------------------------------------------------------|\n| `create-dev` | Set up the virtual environment and install dependencies |\n| `format` | Format the code using `black` and `isort` |\n| `format-check` | Check the code formatting without making changes |\n| `dep-check` | Check for dependency issues using `deptry` |\n| `update-dev` | Update all project dependencies to their latest compatible versions |\n| `test` | Run the test suite with `pytest` and generate coverage reports |\n",
"bugtrack_url": null,
"license": null,
"summary": "Don't be fumblin' no trades now",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d74c41f10a4922015a02ab167d37708abccd311882b17eccb94d875ecfce0849",
"md5": "142c0a194d6a8e01a7fecd51289af846",
"sha256": "7359e4f2398eabb2916b44911794cb8bf7a018f3f9c05e8c4e2e938b05015ae2"
},
"downloads": -1,
"filename": "runefumbler-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "142c0a194d6a8e01a7fecd51289af846",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 4619,
"upload_time": "2024-09-15T20:52:33",
"upload_time_iso_8601": "2024-09-15T20:52:33.035609Z",
"url": "https://files.pythonhosted.org/packages/d7/4c/41f10a4922015a02ab167d37708abccd311882b17eccb94d875ecfce0849/runefumbler-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b68c6cae55b9531643b95d596797f1a5e86e64fc524d3398c66f70bb6813e0ca",
"md5": "491c9579b6582130152ddb68aa38e319",
"sha256": "bd20c324eb30f9cca80f15ffa425a6f11cb509c7cbcb71eb8868c14dbfbc5f58"
},
"downloads": -1,
"filename": "runefumbler-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "491c9579b6582130152ddb68aa38e319",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 4558,
"upload_time": "2024-09-15T20:52:34",
"upload_time_iso_8601": "2024-09-15T20:52:34.384733Z",
"url": "https://files.pythonhosted.org/packages/b6/8c/6cae55b9531643b95d596797f1a5e86e64fc524d3398c66f70bb6813e0ca/runefumbler-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-15 20:52:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "runefumbler"
}
